mirrors/nextcloud-documentation
3
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2025-10-26 11:18:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #9302 from nextcloud/artonge/fix/table_tips_followup

Browse Source 
Follow up on table management tips
This commit is contained in:
Joas Schilling 2023-02-07 19:26:24 +01:00 committed by GitHub
commit a7625fe4b7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
developer_manual/basics/storage/database.rst
View File

@ -332,18 +332,20 @@ Slugs are used to identify resources in the URL by a string rather than integer
$author->slugify('name'); // Some-thing
Table management tips
-------------------------
---------------------
It makes sense to apply some general tips from the beginning, so you don't have to migrate your data and schema later on.
1. Don't use table name longer than 23 characters. As Oracle is limited to 30 chars and we need 3 more for `oc_` at the beginning and 5 for the primary key suffix `_pkey`.
1. Don't use table name longer than 23 characters. As Oracle is limited to 30 chars and we need 3 more for ``oc_`` at the beginning and 5 for the primary key suffix ``_pkey``.
2. Add an auto-incremented ``id`` column. This will ease the use of ``QBMapper`` + ``Entity`` approach:
2. Add an auto-incremented `id` column. This will ease the use of `QBMapper` + `Entity` approach:
- https://github.com/nextcloud/server/blob/master/lib/public/AppFramework/Db/QBMapper.php
- https://github.com/nextcloud/server/blob/master/lib/public/AppFramework/Db/Entity.php
.. code-block:: php
<?php
$table->addColumn('id', Types::BIGINT, [
'autoincrement' => true,
'notnull' => true,
@ -355,12 +357,14 @@ It makes sense to apply some general tips from the beginning, so you don't have
.. code-block:: php
<?php
$table->setPrimaryKey(['id']);
4. Manually set the name of your indexes. It will help you to manipulate them if needed in the future. Note that the names of the index are "global" database wide in some DBs. So having generic names can create conflicts.
4. Manually set the name of your indexes. It will help you to manipulate them if needed in the future. Note that the names of the index are "global" database wide in some database platforms. So having generic names can create conflicts.
.. code-block:: php
<?php
$table->addUniqueIndex(['your', 'column', 'names', '...'], 'table_name_uniq_feature');
Supporting more databases