<div align="center">
<img alt="logo" width="400" src="https://raw.githubusercontent.com/FurryCoders/Logos/main/logos/falocalrepo-database-transparent.png">
# FALocalRepo-Database
Database functionality for [falocalrepo](https://pypi.org/project/falocalrepo).
[](https://github.com/FurryCoders/falocalrepo-database)
[](https://pypi.org/project/falocalrepo-database/)
[](https://www.python.org)
</div>
## Tables
To store its information, the database uses separate tables: `USERS`, `SUBMISSIONS`, `JOURNALS`, `SETTINGS`,
and `HISTORY`.
**Note**: bar-separated lists are formatted as `|item1||item2|` to properly isolate all elements
### Users
The users' table contains a list of all the users that have been download with the program, the folders that have been
downloaded, and the submissions found in each of those.
Each entry contains the following fields:
* `USERNAME` the URL username of the user (no underscores or spaces)
* `FOLDERS` the folders downloaded for that specific user, sorted and bar-separated
* `ACTIVE` `1` if the user is active, `0` if not
* `USERPAGE` the user's profile in HTML or BBCode format
### Submissions
The submissions' table contains the metadata of the submissions downloaded by the program and information on their files
* `ID` the id of the submission
* `AUTHOR` the username of the author (uploader) in full format
* `TITLE`
* `DATE` upload date in ISO format _YYYY-MM-DDTHH:MM_
* `DESCRIPTION` description in HTML or BBCode format
* `FOOTER` footer in HTML or BBCode format
* `TAGS` bar-separated tags
* `CATEGORY`
* `SPECIES`
* `GENDER`
* `RATING`
* `TYPE` image, text, music, or flash
* `FILEURL` a bar-separated list of the remote URLs for the submission files
* `FILEEXT` a bar-separated list of extensions of the downloaded files. Can be empty if the file contained errors and
could not be recognised upon download
* `FILESAVED` file and thumbnail download status as a 3bit flag:`xx1` if thumbnail was downloaded, `xx0` if not; `x1x`
if at least one file was valid `x0x` if not; `1xx` if all given files where valid, `0xx` if not. Possible values
are `0` through `7` (3 bit).
* `FAVORITE` a bar-separated list of users that have "faved" the submission
* `MENTIONS` a bar-separated list of users that are mentioned in the submission description as links
* `FOLDER` the folder of the submission (`gallery` or `scraps`)
* `USERUPDATE` `1` if the submission was added as a user update otherwise `0`
### Journals
The journals' table contains the metadata of the journals downloaded by the program.
* `ID` the id of the journal
* `AUTHOR` the username of the author (uploader) in full format
* `TITLE`
* `DATE` upload date in ISO format _YYYY-MM-DDTHH:MM_
* `CONTENT` content in HTML or BBCode format
* `HEADER` header in HTML or BBCode format
* `FOOTER` footer in HTML or BBCode format
* `MENTIONS` a bar-separated list of users that are mentioned in the journal content as links
* `USERUPDATE` `1` if the journal was added as a user update otherwise `0`
### Comments
The comments' table contains the metadata of the journals and submissions stored in the database.
* `ID` the id of the comment
* `PARENT_TABLE` `SUBMISSIONS` if the comment relates to a submission, `JOURNAL` if the comment relates to a journal
* `PARENT_ID` the id of the parent object (submission or journal)
* `REPLY_TO` the id of the parent comment, if the comment is a reply
* `AUTHOR` the username of the author in full format
* `DATE` post date in ISO format _YYYY-MM-DDTHH:MM:SS_
* `TEXT` the text of the comment
### Settings
The settings table contains settings for the program and variable used by the database handler and main program.
* `COOKIES` cookies for the download program, stored in JSON format
* `FILESFOLDER` location of downloaded submission files
* `VERSION` database version
### History
The history table holds events related to the database.
* `TIME` event time in ISO format _YYYY-MM-DDTHH:MM:SS.ssssss_
* `EVENT` the event description
## Submission Files
The `save_submission` functions saves the submission metadata in the database and stores the files.
Submission files are saved in a tiered tree structure based on their submission ID. IDs are zero-padded to 10 digits and
then broken up in 5 segments of 2 digits; each of these segments represents a folder tha will be created in the tree.
For example, a submission `1457893` will be padded to `0001457893` and divided into `00`, `01`, `45`, `78`, `93`. The
submission file will then be saved as `00/01/45/78/93/submission.file` with the correct extension extracted from the
file itself (FurAffinity links do not always contain the right extension and sometimes confuse JPEG and PNG).
## Upgrading Database
_Note:_ versions prior to 4.19.0 are not supported by falocalrepo-database version 5.0.0 and above. To update from
those, use [falocalrepo v3.25.0](https://pypi.org/project/falocalrepo/v3.25.0) to upgrade the database to version
4.19.0.<br/>
_Note:_ Versions prior to 2.7.0 are not supported by falocalrepo-database version 3.0.0 and above. To update from those
to the new version use [falocalrepo v2.11.2](https://github.com/FurryCoders/FALocalRepo/releases/tag/v2.11.2) to upgrade
the database to version 2.7.0
Raw data
{
"_id": null,
"home_page": "https://github.com/FurryCoders/falocalrepo-database",
"name": "falocalrepo-database",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Matteo Campinoti",
"author_email": "matteo.campinoti94@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/94/ec/db0ff9eca9fe8532aa10f4552a0624e8a354bc24220063954794adc1897c/falocalrepo_database-5.4.6.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n<img alt=\"logo\" width=\"400\" src=\"https://raw.githubusercontent.com/FurryCoders/Logos/main/logos/falocalrepo-database-transparent.png\">\n\n# FALocalRepo-Database\n\nDatabase functionality for [falocalrepo](https://pypi.org/project/falocalrepo).\n\n[](https://github.com/FurryCoders/falocalrepo-database)\n[](https://pypi.org/project/falocalrepo-database/)\n[](https://www.python.org)\n\n</div>\n\n## Tables\n\nTo store its information, the database uses separate tables: `USERS`, `SUBMISSIONS`, `JOURNALS`, `SETTINGS`,\nand `HISTORY`.\n\n**Note**: bar-separated lists are formatted as `|item1||item2|` to properly isolate all elements\n\n### Users\n\nThe users' table contains a list of all the users that have been download with the program, the folders that have been\ndownloaded, and the submissions found in each of those.\n\nEach entry contains the following fields:\n\n* `USERNAME` the URL username of the user (no underscores or spaces)\n* `FOLDERS` the folders downloaded for that specific user, sorted and bar-separated\n* `ACTIVE` `1` if the user is active, `0` if not\n* `USERPAGE` the user's profile in HTML or BBCode format\n\n### Submissions\n\nThe submissions' table contains the metadata of the submissions downloaded by the program and information on their files\n\n* `ID` the id of the submission\n* `AUTHOR` the username of the author (uploader) in full format\n* `TITLE`\n* `DATE` upload date in ISO format _YYYY-MM-DDTHH:MM_\n* `DESCRIPTION` description in HTML or BBCode format\n* `FOOTER` footer in HTML or BBCode format\n* `TAGS` bar-separated tags\n* `CATEGORY`\n* `SPECIES`\n* `GENDER`\n* `RATING`\n* `TYPE` image, text, music, or flash\n* `FILEURL` a bar-separated list of the remote URLs for the submission files\n* `FILEEXT` a bar-separated list of extensions of the downloaded files. Can be empty if the file contained errors and\n could not be recognised upon download\n* `FILESAVED` file and thumbnail download status as a 3bit flag:`xx1` if thumbnail was downloaded, `xx0` if not; `x1x`\n if at least one file was valid `x0x` if not; `1xx` if all given files where valid, `0xx` if not. Possible values\n are `0` through `7` (3 bit).\n* `FAVORITE` a bar-separated list of users that have \"faved\" the submission\n* `MENTIONS` a bar-separated list of users that are mentioned in the submission description as links\n* `FOLDER` the folder of the submission (`gallery` or `scraps`)\n* `USERUPDATE` `1` if the submission was added as a user update otherwise `0`\n\n### Journals\n\nThe journals' table contains the metadata of the journals downloaded by the program.\n\n* `ID` the id of the journal\n* `AUTHOR` the username of the author (uploader) in full format\n* `TITLE`\n* `DATE` upload date in ISO format _YYYY-MM-DDTHH:MM_\n* `CONTENT` content in HTML or BBCode format\n* `HEADER` header in HTML or BBCode format\n* `FOOTER` footer in HTML or BBCode format\n* `MENTIONS` a bar-separated list of users that are mentioned in the journal content as links\n* `USERUPDATE` `1` if the journal was added as a user update otherwise `0`\n\n### Comments\n\nThe comments' table contains the metadata of the journals and submissions stored in the database.\n\n* `ID` the id of the comment\n* `PARENT_TABLE` `SUBMISSIONS` if the comment relates to a submission, `JOURNAL` if the comment relates to a journal\n* `PARENT_ID` the id of the parent object (submission or journal)\n* `REPLY_TO` the id of the parent comment, if the comment is a reply\n* `AUTHOR` the username of the author in full format\n* `DATE` post date in ISO format _YYYY-MM-DDTHH:MM:SS_\n* `TEXT` the text of the comment\n\n### Settings\n\nThe settings table contains settings for the program and variable used by the database handler and main program.\n\n* `COOKIES` cookies for the download program, stored in JSON format\n* `FILESFOLDER` location of downloaded submission files\n* `VERSION` database version\n\n### History\n\nThe history table holds events related to the database.\n\n* `TIME` event time in ISO format _YYYY-MM-DDTHH:MM:SS.ssssss_\n* `EVENT` the event description\n\n## Submission Files\n\nThe `save_submission` functions saves the submission metadata in the database and stores the files.\n\nSubmission files are saved in a tiered tree structure based on their submission ID. IDs are zero-padded to 10 digits and\nthen broken up in 5 segments of 2 digits; each of these segments represents a folder tha will be created in the tree.\n\nFor example, a submission `1457893` will be padded to `0001457893` and divided into `00`, `01`, `45`, `78`, `93`. The\nsubmission file will then be saved as `00/01/45/78/93/submission.file` with the correct extension extracted from the\nfile itself (FurAffinity links do not always contain the right extension and sometimes confuse JPEG and PNG).\n\n## Upgrading Database\n\n_Note:_ versions prior to 4.19.0 are not supported by falocalrepo-database version 5.0.0 and above. To update from\nthose, use [falocalrepo v3.25.0](https://pypi.org/project/falocalrepo/v3.25.0) to upgrade the database to version\n4.19.0.<br/>\n_Note:_ Versions prior to 2.7.0 are not supported by falocalrepo-database version 3.0.0 and above. To update from those\nto the new version use [falocalrepo v2.11.2](https://github.com/FurryCoders/FALocalRepo/releases/tag/v2.11.2) to upgrade\nthe database to version 2.7.0\n",
"bugtrack_url": null,
"license": "EUPL-1.2",
"summary": "Database functionality for falocalrepo.",
"version": "5.4.6",
"project_urls": {
"Changelog": "https://github.com/FurryCoders/falocalrepo-database/blob/master/CHANGELOG.md",
"Download": "https://pypi.org/project/falocalrepo-database/#files",
"Homepage": "https://github.com/FurryCoders/falocalrepo-database",
"Repository": "https://github.com/FurryCoders/falocalrepo-database",
"Source": "https://github.com/FurryCoders/falocalrepo-database"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "877987bce73593753e8822f043e7f0adcc8e9a85b61bf38eb47683ceee633dc7",
"md5": "4178a4dfa62e5ed8682cd6b2f74838ed",
"sha256": "c1c9a31c13c62dadd58a940b4a0de6bded956dc90a79fcbcbf9404e523ba3f16"
},
"downloads": -1,
"filename": "falocalrepo_database-5.4.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4178a4dfa62e5ed8682cd6b2f74838ed",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 27170,
"upload_time": "2024-08-22T21:33:12",
"upload_time_iso_8601": "2024-08-22T21:33:12.069024Z",
"url": "https://files.pythonhosted.org/packages/87/79/87bce73593753e8822f043e7f0adcc8e9a85b61bf38eb47683ceee633dc7/falocalrepo_database-5.4.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "94ecdb0ff9eca9fe8532aa10f4552a0624e8a354bc24220063954794adc1897c",
"md5": "7478f878f20264e15ef01b325b95a266",
"sha256": "b365f10b043ad4f27f45dccf0bea33e8cd4a6ee3cfaaf252996677551a458854"
},
"downloads": -1,
"filename": "falocalrepo_database-5.4.6.tar.gz",
"has_sig": false,
"md5_digest": "7478f878f20264e15ef01b325b95a266",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 26591,
"upload_time": "2024-08-22T21:33:13",
"upload_time_iso_8601": "2024-08-22T21:33:13.761280Z",
"url": "https://files.pythonhosted.org/packages/94/ec/db0ff9eca9fe8532aa10f4552a0624e8a354bc24220063954794adc1897c/falocalrepo_database-5.4.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-22 21:33:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FurryCoders",
"github_project": "falocalrepo-database",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "falocalrepo-database"
}
JSON
