Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improving formatting of Identifier Generation Strategies #10574

Closed
wants to merge 2 commits into from
Closed

Improving formatting of Identifier Generation Strategies #10574

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34765e6
Improving formating of Identifier Generation Strategies
ThomasLandauer Mar 12, 2023
61bba8b
Update basic-mapping.rst
ThomasLandauer Mar 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 11 additions & 16 deletions docs/en/reference/basic-mapping.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,36 +423,31 @@ the field that serves as the identifier with the ``#[Id]`` attribute.
# fields here

In most cases using the automatic generator strategy (``#[GeneratedValue]``) is
what you want. It defaults to the identifier generation mechanism your current
database vendor prefers: AUTO_INCREMENT with MySQL, sequences with PostgreSQL
and Oracle and so on.
what you want.

.. _identifier-generation-strategies:

Identifier Generation Strategies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The previous example showed how to use the default identifier
generation strategy without knowing the underlying database with
the AUTO-detection strategy. It is also possible to specify the
identifier generation strategy more explicitly, which allows you to
make use of some additional features.

Here is the list of possible generation strategies:

- ``AUTO`` (default): Tells Doctrine to pick the strategy that is
preferred by the used database platform. The preferred strategies
are IDENTITY for MySQL, SQLite, MsSQL and SQL Anywhere and SEQUENCE
for Oracle and PostgreSQL. This strategy provides full portability.
preferred by the used database platform:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this is no longer true since #8870 : AbstractPlatform::prefers* methods have been removed. It's now more based on what the platforms supports:

orm/lib/Doctrine/ORM/Mapping/ClassMetadataFactory.php

Lines 727 to 745 in da9b9de

private function determineIdGeneratorStrategy(AbstractPlatform $platform): int
{
if (
$platform instanceof Platforms\OraclePlatform
|| $platform instanceof Platforms\PostgreSQLPlatform
) {
return ClassMetadata::GENERATOR_TYPE_SEQUENCE;
}
if ($platform->supportsIdentityColumns()) {
return ClassMetadata::GENERATOR_TYPE_IDENTITY;
}
if ($platform->supportsSequences()) {
return ClassMetadata::GENERATOR_TYPE_SEQUENCE;
}
throw CannotGenerateIds::withPlatform($platform);
}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Related: #8931

- MySQL, SQLite, MsSQL, SQL Anywhere: ``IDENTITY``
- Oracle, PostgreSQL: ``SEQUENCE``
This strategy provides full portability.
- ``SEQUENCE``: Tells Doctrine to use a database sequence for ID
generation. This strategy does currently not provide full
portability. Sequences are supported by Oracle, PostgreSql and
portability. Sequences are supported by Oracle, PostgreSQL and
SQL Anywhere.
- ``IDENTITY``: Tells Doctrine to use special identity columns in
the database that generate a value on insertion of a row. This
strategy does currently not provide full portability and is
supported by the following platforms: MySQL/SQLite/SQL Anywhere
(AUTO\_INCREMENT), MSSQL (IDENTITY) and PostgreSQL (SERIAL).
supported by the following platforms:
- MySQL, SQLite, SQL Anywhere: ``AUTO_INCREMENT``
- MsSQL: ``IDENTITY``
- PostgreSQL: ``SERIAL``
- ``UUID`` (deprecated): Tells Doctrine to use the built-in Universally
Unique Identifier generator. This strategy provides full portability.
- ``NONE``: Tells Doctrine that the identifiers are assigned (and
Expand Down Expand Up @@ -580,7 +575,7 @@ needs to be done explicitly using ticks in the definition.

<?php

#[Column(name: '`number`', type: 'integer')]
#[Column(name: '`number`')]
private $number;

Doctrine will then quote this column name in all SQL statements
Expand Down