http://www.doctrine-project.org/jira This file is an XML representation of an issue en-us 5.2.7 850 21-02-2013 http://www.doctrine-project.org/jira/browse/DDC-451 Doctrine 2 - ORM <p>We should add an IdGenerator that facilitates the DB Vendors UUID()/GUID() generation facilities.</p> <p>Although these IdGenerators take more space compared to other Generators there are use-cases which can be only solved with this kind of Id Generator.</p> DDC-451

Add GUID/UUID Id Generator

New Feature Minor Resolved Fixed All Benjamin Eberlei Benjamin Eberlei Sat, 20 Mar 2010 14:04:48 +0000 Mon, 13 Aug 2012 20:27:11 +0000 Mon, 12 Mar 2012 12:04:35 +0000 2.0-ALPHA4 2.3 ORM 3 6 <p>Here is a basic GUID generator.</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java">class Guid { /** * Generate a GUID * * @<span class="code-keyword">return</span> string */ <span class="code-keyword">public</span> <span class="code-keyword">static</span> function generate() { $cpuname = getenv('COMPUTERNAME'); $address = isset($_SERVER['SERVER_ADDR']) ? @$_SERVER['SERVER_ADDR'] : uniqid(hash(<span class="code-quote">"md5"</span>, time()), <span class="code-keyword">true</span>) . time(); $address = (trim($cpuname) == '' ? crypt(uniqid(rand(), <span class="code-keyword">true</span>)) : $cpuname) . '/' . $address; $milisecs = microtime(); $randomLong = (rand(0, 1))? '-':''; $randomLong .= rand(1000, 9999).rand(1000, 9999).rand(1000, 9999).rand(100, 999).rand(100, 999); $string = $address . ':' . $milisecs . ':' . $randomLong; $hashString = strtoupper(md5($string)); <span class="code-keyword">return</span> substr($hashString, 0, 8).'-'.substr($hashString, 8, 4).'-'.substr($hashString, 12, 4).'-'.substr($hashString, 16, 4).'-'.substr($hashString, 20); } /** * Verifies <span class="code-keyword">if</span> a string is a valid Guid generated acording to <span class="code-keyword">this</span> class * * @param string $guid Guid to be analyzed * @<span class="code-keyword">return</span> <span class="code-object">boolean</span> */ <span class="code-keyword">public</span> <span class="code-keyword">static</span> function match($guid) { $match = preg_match(<span class="code-quote">"/^([A-F0-9]{8}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{12})$/"</span>, $guid); <span class="code-keyword">return</span> $match; } } </pre> </div></div> <p>I agree, there are some application features that can only be done with GUID.</p> <p>Oh, thats a quite simple implementation of a UUID/GUID generator.</p> <p>I would prefer something like this:<br/> <a href="http://github.com/volkszaehler/volkszaehler.org/blob/master/backend/lib/Util/UUID.php" class="external-link">http://github.com/volkszaehler/volkszaehler.org/blob/master/backend/lib/Util/UUID.php</a></p> <p>Its a RFC2144 compatible implementation for UUIDs</p> <p>Here is complete code how to do this - <a href="http://ranskills.wordpress.com/2011/05/26/how-to-add-a-custom-id-generation-strategy-to-doctrine-2-0/" class="external-link">http://ranskills.wordpress.com/2011/05/26/how-to-add-a-custom-id-generation-strategy-to-doctrine-2-0/</a>.</p> <p>A couple of months ago I created 2 pull requests for this feature (<a href="https://github.com/doctrine/doctrine2/pull/127" class="external-link">https://github.com/doctrine/doctrine2/pull/127</a> and <a href="https://github.com/doctrine/dbal/pull/58" class="external-link">https://github.com/doctrine/dbal/pull/58</a>). It would be nice if the feature is in the next Doctrine release.</p> <p>Implemented</p> <p>Details: This works with Database provided GUID functionality only for now, the UUID Generator uses the AbstractPlatform#getGuidSqlExpression() function and a SELECT clause to fetch a new guid. A next step might be to add a Platform#supportsGuidGeneration() flag and otherwise fallback to a PHP based generation.</p> <p>The Id generator in the ORM is pre insert, which makes this very awesome <img class="emoticon" src="http://www.doctrine-project.org/jira/images/icons/emoticons/smile.gif" height="20" width="20" align="absmiddle" alt="" border="0"/></p> <p>There is a <a href="https://github.com/ramsey/uuid" class="external-link">nice implementation</a> out there with proper UUID generation and a DBAL datatype.</p> <p>starting with 2.3 there are custom id generators and you can do whatever you want. There is also a UUID/GUID type in 2.3 that is using the appropriate vendor database functions to generate those values.</p> <blockquote> <p> There is also a UUID/GUID type in 2.3 that is using the appropriate vendor database functions to generate those values.</p></blockquote> <p>So how would one be able to use this UUID/GUID? Would it be required for the column to be tagged as a @Id and @GeneratedValue with GUID strategy? I would like to have a random string generated which does not act as @Id within Doctrine... The text quoted suggests that it should work out of the box by setting the column type to 'guid', which it does not (2.3.0-RC1).</p> <p>Simply setting the column type to 'guid' does not trigger the database to generate an ID when INSERTing a row...</p> <p>I'm not sure about PHP's case sensitivity, but as of <a href="https://github.com/doctrine/doctrine2/blob/00a5f185444fb5d7c84e445d9ea6d6a68e087f98/lib/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php#L310" class="external-link">https://github.com/doctrine/doctrine2/blob/00a5f185444fb5d7c84e445d9ea6d6a68e087f98/lib/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php#L310</a> I think you should try with "UUID" (uppercase)</p> <p>Marco, it is indeed 'UUID', but this seems not to kick in when there is no @Id annotation used. I want to use it to come up with an identifier for an Order. It is not a primary key at database level or something like that. I was just wondering whether this new functionality can be used like that. I get the feeling it is not intended to be used like this: </p> <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent"> <pre>/** * Unique Order identifier that acts as reference for an Order even when multiple databases are involved * * @var string * @ORM\Column(name="order_identifier", type="string", unique=true) * @ORM\GeneratedValue(strategy="UUID") */ protected $_orderIdentifier; </pre> </div></div> <p>Well it is an ID generator. So it has to be with @Id.</p> <p>Well, yes, that was my question and that is now answered, thanks. </p> <p>It would be nice though to have UUID generation functionality available for non-database specific IDs as well. For instance for:</p> <ul> <li>user account activation tokens</li> <li>payment references</li> <li>invoice reference, etc.</li> </ul> <p>This is now something that has to be implemented at the applciation level. But since we have these generators available, why not re-use it. By adding a @Id annotation, it becomes part of a composite key, which is not the purpose. Maybe I'll dive into the code and see whether this is possible.</p> <p>it is available, just take a look at the code.</p> <blockquote><p>Well it is an ID generator. So it has to be with @Id.</p></blockquote> <blockquote><p>it is available, just take a look at the code.</p></blockquote> <p>Mmm, now I am confused, I think we are mis-communicating. </p> <p>Maybe using less text and more descriptive examples:</p> <ul> <li>is it possible to use Database GUID functionality <ul> <li>without using the @Id annotations, to generate values for Entity properties that are not a primary key?</li> <li>note that this Entity unique reference would exist next to a property that does have the @Id annotation</li> </ul> </li> </ul> <p>Attempt 1:</p> <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent"> <pre>/** * The Order ID used at database level, which does NOT have any meaning within our domain, solely at database level * * @var integer * @ORM\Column(name="id", type="integer") * @ORM\Id * @ORM\GeneratedValue(strategy="IDENTITY") * @ORM\SequenceGenerator(sequenceName="orders_id_seq") */ protected $_id; /** * The Order reference used at domain level, which DOES have meaning in our domain * Typically used to report in emails, printed on Invoices, etc * * @var string * @ORM\Column(name="order_identifier", type="guid") */ protected $_orderIdentifier; </pre> </div></div> <p>Attempt 2:</p> <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent"> <pre>/** * The Order ID used at database level, which does NOT have meaning within our domain, solely at database level * * @var integer * @ORM\Column(name="id", type="integer") * @ORM\Id * @ORM\GeneratedValue(strategy="IDENTITY") * @ORM\SequenceGenerator(sequenceName="orders_id_seq") */ protected $_id; /** * The Order reference used at domain level, which DOES have meaning in our domain * Typically used to report in emails, printed on Invoices, etc * * @var string * @ORM\Column(name="order_identifier", type="string", unique=true) * @ORM\GeneratedValue(strategy="UUID") */ protected $_orderIdentifier; </pre> </div></div> <p>Based on Benjamin's first answer I guess that this is not possible. Point is, the second answer indicates that it is possible <img class="emoticon" src="http://www.doctrine-project.org/jira/images/icons/emoticons/wink.gif" height="20" width="20" align="absmiddle" alt="" border="0"/>. What is it?</p> <p>Also note that in Attempt 2, the @GeneratedValue annotation on the second property interferes with the ID generation of the Entity defined at the first property. This is probably to realize composite keys, but can result in unexpected behavior since it replaces the way the primary key is generated?</p> <p>Well @GeneratedValue Only works with @Id as I said. But there are low level APIs that you can look up in the UuidGenerator Strategy to use for something like this.</p>