Commit Graph

58 Commits

Author SHA1 Message Date
Christoph Wurst
8f01d5c11f feat(devmanual): add section about system config key conventions
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2025-07-17 16:32:30 +02:00
Ronny Bremer
9d5c5eb1a3 adopted documentation on how to create a new file or override an existing file
previous code was outdated and didn't work anymore in newer NC versions (possibly since NC 29)

Signed-off-by: Ronny Bremer <rbremer@almanid.com>
2025-05-22 13:21:34 +02:00
Christoph Wurst
56d0977384 feat(devmanual): Clarify behavior of missing replacement indexes
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2025-03-13 08:11:38 +01:00
Paul
6af4c226b1 Fix typo Athor —> Author
Signed-off-by: Paul <devnoname120@gmail.com>
2025-02-24 17:58:23 +01:00
Ferdinand Thiessen
d8198ad7a3 Merge pull request #12293 from nextcloud/developer/database-types
feat(developer): Document new database field types
2024-11-09 17:05:12 +01:00
Maxence Lange
4b66d6bd4b migration attributes
Signed-off-by: Maxence Lange <maxence@artificial-owl.com>
2024-10-30 10:02:19 -01:00
Ferdinand Thiessen
4545435bb6 feat(developer): Document new database field types
Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2024-10-18 19:43:42 +02:00
Daniel Kesselberg
2f269adec6 feat: hello codespell
Signed-off-by: Daniel Kesselberg <mail@danielkesselberg.de>
2024-07-23 13:04:10 +02:00
Christoph Wurst
864617c80f feat(dev): Add an example for transient db entity attributes
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2024-03-27 10:03:35 +01:00
Ferdinand Thiessen
53e467ddc9 Merge pull request #11550 from nextcloud/docs/dev/db-indexes
docs(dev): Mention new uniqueness check for index names
2024-03-08 00:07:44 +01:00
Josh
11e7260e71 Update developer_manual/basics/storage/database.rst
Co-authored-by: Joas Schilling <213943+nickvergessen@users.noreply.github.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
2024-02-28 17:18:46 -05:00
Johannes Merkel
7a2bb37142 feat(dev): add replace option to AddMissingIndices
Signed-off-by: Johannes Merkel <mail@johannesgge.de>
2024-02-26 14:18:48 +01:00
Josh
04de7b59b9 docs(dev): Mention new uniqueness check for index names
Follow-on to nextcloud/server#39506 & nextcloud/server#43357

Signed-off-by: Josh <josh.t.richards@gmail.com>
2024-02-17 09:25:51 -05:00
Christoph Wurst
3e7430fb26 feat(devmanual): Add \OCP\DB\IResult::fetch deprecation
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2024-01-19 17:06:09 +01:00
Anna Larch
f799986cda fix(doc): Wrap instance reporting for database schema in an API
Signed-off-by: Anna Larch <anna@nextcloud.com>
2023-09-29 14:43:29 +02:00
Julius Härtl
d9012b5033 feat(dev): Add documentation for new AddMissingIndicesEvent
Signed-off-by: Julius Härtl <jus@bitgrid.net>
2023-07-14 14:37:20 +02:00
Daniel
a86f6d7b91 Merge pull request #10035 from fsamapoor/patch-2
Fixes migrations:execute description in migrations.rst.
2023-04-24 20:39:09 +02:00
Christoph Wurst
c4861bcb6a fix(devmanual): Drop outdated database.xml information
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2023-04-19 09:48:28 +02:00
Faraz Samapoor
f05e543296 Fixes migrations:execute description in migrations.rst.
"Version" is the "prefix" of the class name, not the "postfix".

Signed-off-by: Faraz Samapoor <f.samapoor@gmail.com>
2023-04-11 16:48:09 +03:30
Alexander Piskun
13255982be Fixed some warnings and errors. (#9924)
Signed-off-by: Alexander Piskun <bigcat88@icloud.com>
2023-03-20 16:21:36 +03:00
Louis Chemineau
912773b88a Follow up on table management tips
Signed-off-by: Louis Chemineau <louis@chmn.me>
2023-02-07 18:06:21 +01:00
Faraz Samapoor
585e336d38 Updates the "Migrations" section's phrasing.
To make it more readable and to remove redundant words.

Signed-off-by: Faraz Samapoor <f.samapoor@gmail.com>
2023-01-09 13:21:57 +03:30
Christoph Wurst
deb51a5240 Use captions to better highlight codeblock file names
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2022-11-14 15:21:36 +01:00
Christoph Wurst
3f9cfe3bd8 Use deprecated directive instead of note
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2022-11-14 13:27:16 +01:00
Christoph Wurst
edb263a02a Document deprecation of entity slugs
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2022-11-14 09:39:38 +01:00
Joas Schilling
867b591954 Document datetime support for the Entity class
Signed-off-by: Joas Schilling <coding@schilljs.com>
2022-11-09 12:32:52 +01:00
Louis
6712d40524 Merge pull request #9283 from nextcloud/artonge/feat/table_management_tips
Add table management tips for developers
2022-11-08 13:41:17 +01:00
Louis Chemineau
df4819dd92 Add table management tips for developers
Signed-off-by: Louis Chemineau <louis@chmn.me>
2022-11-08 13:38:05 +01:00
Christian Wolf
e0afb73e7c Removed wrong capitalization and few bugs in Sphinx build
Signed-off-by: Christian Wolf <github@christianwolf.email>
2022-11-03 15:43:40 +01:00
Robin Windey
8073549620 Improve migration docs
* Add section on how migration classes are constructed
* Add a hint for "version" argument on "migrations:execute"

Signed-off-by: Robin Windey <ro.windey@gmail.com>
2022-09-03 12:18:51 +02:00
Carl Schwan
888ad06e72 Cleanup part of the developer api
- Port away from deprecated stuff
- Update php syntax

Signed-off-by: Carl Schwan <carl@carlschwan.eu>
2022-05-16 15:53:27 +02:00
Louis Chemineau
347f64d5c2 Add high level filesystem documention
From https://github.com/nextcloud/server/pull/26982

Adds some documentation for the filesystem layer, both a high level overview of how the various pieces interact and a high level guide for apps interacting with the filesystem.

Hopefully this will be useful to anyone trying to either use the filesystem or work on the filesystem.

Signed-off-by: Louis Chemineau <louis@chmn.me>
2022-05-02 14:18:20 +02:00
Vitor Mattos
31661e7113 Fix appdata url
Signed-off-by: Vitor Mattos <vitor@php.rio>
2022-04-25 20:02:30 -03:00
tflidd
2d620bee2c Merge pull request #8134 from nextcloud/sualko-patch-1
emphasize that debug mode is required
2022-04-22 19:29:48 +02:00
Joas Schilling
9af1862f84 Document the string length issue
Signed-off-by: Joas Schilling <coding@schilljs.com>
2022-04-04 16:03:28 +02:00
Joas Schilling
dfee257fc2 Document database requirements and specialties
Signed-off-by: Joas Schilling <coding@schilljs.com>
2022-03-17 16:08:59 +01:00
Klaus
9b644bef94 emphasize that debug mode is required 2022-03-16 15:59:52 +01:00
Joas Schilling
ee73b3e241 Fix transaction method name
Signed-off-by: Joas Schilling <coding@schilljs.com>
2022-02-24 11:54:06 +01:00
Côme Chilliet
42773a35d8 Merge pull request #8048 from nextcloud/enhancement/dev-ttransactional
Document TTransactional for developers
2022-02-21 10:07:39 +01:00
Christoph Wurst
6088dd56d1 Merge pull request #7851 from nextcloud/mejo--patch-1
Update configuration.rst, mention HintException
2022-02-21 08:55:13 +01:00
Christoph Wurst
53524d8542 Document TTransactional for developers
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2022-02-18 12:42:45 +01:00
Cyrille Bollu
7b29164174 Adds a provision about 'composer dump-autoload' to the migrations
chapter

Signed-off-by: Cyrille Bollu <cyr.debian@bollu.be>
2022-02-09 11:25:17 +01:00
Jonas
237ca61475 Update configuration.rst, mention HintException
With https://github.com/nextcloud/server/pull/30130, `setConfigValue` throws a HintException when config is read-only.

Signed-off-by: Jonas Meurer <jonas@freesources.org>
2022-01-13 12:17:25 +01:00
Aeredren
bb442806e6 Typo 2021-10-08 14:08:22 +02:00
Christoph Wurst
c2d4375701 Document correct db transaction handling
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2021-08-13 13:03:53 +02:00
Vincent Petry
ebca005493 Remove DB schema docs, add note for NC 22
Signed-off-by: Vincent Petry <vincent@nextcloud.com>
2021-06-17 17:42:31 +02:00
Vincent Petry
1f5ffe8253 Remove traces of migrations:generate-from-schema
Remove traces of occ migrations:generate-from-schema which was removed
in NC 22.

Also adjust text that specifies that now ALL migrations:* commands are only
available in debug mode.

Signed-off-by: Vincent Petry <vincent@nextcloud.com>
2021-06-17 15:33:53 +02:00
Lukas Reschke
cce504ca87 Schema -> ISchemaWrapper
This makes my autocomplete happier :)
2021-05-25 19:37:37 +02:00
Michael Hirschler
4a8de965b7 Update filesystem.rst 2021-01-18 16:30:29 +01:00
Christoph Wurst
730f23cbee Recommend our own type constants instead of Doctrine's
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2021-01-15 10:12:29 +01:00