API page: https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Database!database...

The description suggests to "see below" regarding the 'unique keys' array in the schema, however, the example does not contain a unique key definition.

Issue fork drupal-3105737

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

Beakerboy created an issue. See original summary.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.7 was released on June 3, 2020 and is the final full bugfix release for the Drupal 8.8.x series. Drupal 8.8.x will not receive any further development aside from security fixes. Sites should prepare to update to Drupal 8.9.0 or Drupal 9.0.0 for ongoing support.

Bug reports should be targeted against the 8.9.x-dev branch from now on, and new development or disruptive changes should be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

gro’s picture

A couple of approaches are possible to fix this and I'm looking for some consensus on what peoples preference would be.

  1. remove the text "see below" - this doesn't help illustrate this property, although devs can find examples in other core modules i.e. MenuTreeStorage which is possibly too verbose to include in the doc block example
  2. Add an example to the existing doc block in database.api.php - this would break the relationship with the Core user module.
  3. Completely refactor the doc block example and include a customised example for each property - because there isn't a complete example in Core anymore

Point 3 would get my vote.

Version: 8.9.x-dev » 9.2.x-dev

Drupal 8 is end-of-life as of November 17, 2021. There will not be further changes made to Drupal 8. Bugfixes are now made to the 9.3.x and higher branches only. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.15 was released on June 1st, 2022 and is the final full bugfix release for the Drupal 9.3.x series. Drupal 9.3.x will not receive any further development aside from security fixes. Drupal 9 bug reports should be targeted for the 9.4.x-dev branch from now on, and new development or disruptive changes should be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.9 was released on December 7, 2022 and is the final full bugfix release for the Drupal 9.4.x series. Drupal 9.4.x will not receive any further development aside from security fixes. Drupal 9 bug reports should be targeted for the 9.5.x-dev branch from now on, and new development or disruptive changes should be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

smustgrave’s picture

Came up as a daily BSI target and still seems to be relevant.

himani_219 made their first commit to this issue’s fork.

xjm’s picture

Status: Active » Closed (won't fix)
Issue tags: -Needs issue summary update, -Novice

Discussed this issue with @igorgoncalves. I think that in context the "see below" refers only to the term "key column specifiers", which are indeed documented in detail below. Therefore, as a Drupal core release manager, I am marking this wontfix. Thanks for taking the time to review this and make suggestions!

Now that this issue is closed, please review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, please credit people who helped resolve this issue.