mihai-stancu/doctrine-types-extra

Doctrine2 storing `UUID()` as BINARY(16) and `UUID_SHORT()` as BIGINT for MySQL.

dev-master 2016-08-02 08:48 UTC

Requires

• php: >=5.5.9
• doctrine/orm: ^2
• symfony/config: ~2|~3
• symfony/debug: ~2|~3
• symfony/dependency-injection: ~2|~3
• symfony/event-dispatcher: ~2|~3
• symfony/filesystem: ~2|~3
• symfony/http-foundation: ~2|~3
• symfony/http-kernel: ~2|~3

MIT

• Mihai Stancu

• mysql
• doctrine2
• uuid
• guid
• bigint
• binary
• binary_guid
• binary_uuid
• short_guid
• short_uuid

README

Doctrine2's default GUID works as a native data type for platforms that support it (Oracle, MSSQL, PostgreSQL) but falls back to VARCHAR in others (MySQL, SQLite).

• BINARY: binary_guid is an alternative of the default guid type which uses BINARY(16) on all platforms (or VARBINARY(16) on platforms without fixed length binary). The default GeneratedValue (UUID) is used as the generator function and hex2bin / bin2hex converters are used. BinaryGuidType extends BinaryType.
• SHORT: short_guid is an extension of the default guid type which uses BIGINT as a fallback type for UUIDs in MySQL instead of VARCHAR. The UUID_SHORT() function from MySQL is used as the generator function and the results are handled as integers. ShortGuidType extends GuidType.

N.B.: !!! MySQl's short UUIDs are not standard UUIDs and they are not guaranteed to be unique across (...more than 256...) servers.

Sets and enums are not supported in Doctrine2 by default but they can be treated as strings in most scenarios.

• SET: set is a naive implementation of MySQL's set data type represented in PHP as an array of strings. The type only supports generating create statements and implode / explode converters. SetType extends SimpleArrayType.

Usage

Adding the following lines in your app/config.yml (for Symfony2 projects) should do the trick:

doctrine:
    dbal:
        types:
            binary_guid: MS\DoctrineTypes\DBAL\Types\BinaryGuidType
            short_guid: MS\DoctrineTypes\DBAL\Types\ShortGuidType

            set: MS\DoctrineTypes\DBAL\Types\SetType


        mapping_types:
            binary_guid: binary_guid
            short_guid: short_guid

            set: set

And adding the following Annotation comments in your entity definitions should finish the job:

    /**
     * @Id
     * @Column(type="binary_guid")
     * @GeneratedValue(strategy="UUID")
     */

or

    /**
     * @Id
     * @Column(type="short_guid")
     * @GeneratedValue(strategy="CUSTOM")
     * @CustomIdGenerator(class="MS\DoctrineTypes\ORM\Id\ShortGuidGenerator")
     */

or

    /**
     * @Column(type="set", options={ "values"={"value1", "value2"} })
     */