Atlas.Orm 2.0.0-beta1 Released
I am very happy to announce that I have just released 2.0.0-beta1 of Atlas, a data mapper for your SQL persistence model. You can get it via Composer as atlas/orm. This new major version requires PHP 7.1 and uses typehints, but best of all, it is backwards compatible with existing 1.x generated Atlas classes!
The original motivation for starting the 2.x series was an edge-case bug. Atlas lets you open and manage transactions across multiple connections simultaneously; different table classes can point to different database connections. Atlas also lets you save an entire Record and all of its related fields with a single call to the
persist() Mapper or Transaction method.
However, in 1.x, executing a
Transaction::persist() call does not work properly when the relationships are mapped across connections that are not the same as the main Record. This is because the Transaction begins on the main Record connection, but does not have access to the connections for related records, and so cannot track them.
Admittedly, this is an uncommon operation, but ought to be supported properly. The only way to fix it was to break backwards compatibility on the Table and Transaction classes, both on their constructors and on their internal operations, by introducing a new ConnectionManager for them to use for connection and transaction management.
As long as backwards compatibility breaks were going to happen anyway, that created the opportunity to upgrade the package to use PHP 7.1 and typehints. But even with that in mind …
You do not need to modify or regenerate any classes generated from 1.x (although if you have overridden class methods in custom classes, you may need to modify that code to add typehints).
Atlas 2.x continues to use Aura.Sql and Aura.SqlQuery 2.x, so you do not need to change any queries from Atlas 1.x.
You do not need to change any calls to AtlasContainer for setup.
So, the majority of existing code using Atlas 1.x should not have to change at all after upgrading to 2.x.
There are some minor but breaking changes to the return values of some Atlas calls; these are a result of using typehints, especially nullable types.
First, the following methods now return
null (instead of
false) when they fail:
Checking for loosely false-ish return values will continue to work in 2.x as it did in 1.x, but if you were checking strictly for
false you now need to check strictly for
null – or switch to loose checking. (Note that values for a missing related record field are still
null. That is, a related field value of
null still indicates “there was no attempt to fetch a related record,” while
false still indicates “there was an attempt to fetch a related record, but it did not exist.”)
Second, the following methods will now always return a RecordSet, even when no records are found. (Previously, they would return an empty array when no records were found.)
Whereas previously you would check for an empty array or loosely false-ish value as the return value, you should now call
isEmpty() on the returned RecordSet.
That is the extent of user-facing backwards compatibility breaks.
There is one major new piece in 2.x: the table-level ConnectionManager. It is in charge of transaction management for table operations, and allows easy setting of read and write connections to be used for specific tables if desired.
It also allows for on-the-fly replacement of “read” connections with “write” connections. You can specify that this should…
- never happen (the default)
- always happen (which is useful in GET-after-POST situations when latency is high for master-slave replication), or
- happen only when a table has started writing back to the database (which is useful for synchronizing reads with writes while in a transaction)
Other than that, you should not have to deal with the ConnectionManager directly, but it’s good to know what’s going on under the hood.
Although this is a major release, the user-facing backwards-compatibility changes are very limited, so it should be an easy migration from 1.x. There is very little new functionality, so I’m releasing this as a beta instead of an alpha. I have yet to update the official documentation site, but the in-package docs are fully up-to-date.
I can think of no reason to expect significant API changes between now and a stable release, which should arrive in the next couple of weeks if there are no substantial bug reports.
Thanks for reading, and I hope that Atlas can help you out on your next project!