Align with CakePHP on datetime and timestamp types

Oct 13, 2025 by pinkandtrash.com 56 views

RFC - Aligning Abstract Types with CakePHP

Introduction

As we continue to evolve and improve the CakePHP framework, it's essential to ensure that our database migration system aligns with the conventions and best practices established by CakePHP. Currently, migrations support the Phinx abstract type set in migration files, but this can lead to inconsistencies and potential issues when working with different database dialects. In this RFC, we propose aligning migrations with the CakePHP/database conventions to ensure a seamless and consistent experience for developers.

Types Missing in CakePHP

MySQL

enum: Currently, migrations support the enum type, but it's not directly supported in CakePHP. Instead, we recommend using varchar columns with mapped types.
set: Similar to enum, the set type is not supported in CakePHP and can be replaced with varchar columns.
year: The year type is not supported in CakePHP and can be shimmed with a compatibility layer.
json: The json type is not supported in CakePHP and can be shimmed with a compatibility layer.

The following types can be shimmed with length:

tinyblob: Can be shimmed with a length of 255.
mediumblob: Can be shimmed with a length of 16777215.
longblob: Can be shimmed with a length of 4294967295.
mediuminteger: Can be shimmed with a length of 8.

Postgres

jsonb: The jsonb type is not supported in CakePHP and can be shimmed with a compatibility layer.
cidr: The cidr type is not supported in CakePHP and can be shimmed with a compatibility layer.
inet: The inet type is not supported in CakePHP and can be shimmed with a compatibility layer.
macaddr: The macaddr type is not supported in CakePHP and can be shimmed with a compatibility layer.
interval: The interval type is not supported in CakePHP and can be shimmed with a compatibility layer.

Sqlserver

filestream: The filestream type is not supported in CakePHP and can be shimmed with a compatibility layer.

Handling Length-Based Aliases

The blob/integer aliases seem simple enough to shim with a compatibility layer when running migrations. However, during schema reflection, these types would be reflected as binary with lengths (as they do in CakePHP today).

Proposed Deprecations/Removals

Deprecate support for enum and set types in migrations: Migrations using these types will emit deprecations in migrations 4.7. We have historically avoided supporting ENUM in CakePHP because of the footgun they create for applications down the road. Instead, we recommend folks use varchar columns with mapped types.
Deprecate support for inet, macaddr, interval types in Postgres: These types are not portable between database dialects and don't currently have support in CakePHP.
Deprecate support for filestream type in Sqlserver: This type is not supported in CakePHP and can be shimmed with a compatibility layer.
Deprecate the AdapterInterface::PHINX_TYPE_* constants: Instead, we can use the CakePHP ones.
Align with CakePHP on datetime and timestamp types: This will result in different types being used in migration and dump files.

Conclusion

Aligning migrations with the CakePHP/database conventions will ensure a seamless and consistent experience for developers. By deprecating and removing unsupported types, we can simplify the migration process and reduce the risk of issues when working with different database dialects. We propose the following changes:

Deprecate support for enum and set types in migrations.
Deprecate support for inet, macaddr, interval types in Postgres.
Deprecate support for filestream type in Sqlserver.
Deprecate the AdapterInterface::PHINX_TYPE_* constants.
Align with CakePHP on datetime and timestamp types.

By implementing these changes, we can ensure that our migration system aligns with the best practices established by CakePHP and provides a seamless experience for developers.
RFC - Aligning Abstract Types with CakePHP: Q&A

Introduction

As we continue to evolve and improve the CakePHP framework, it's essential to ensure that our database migration system aligns with the conventions and best practices established by CakePHP. In our previous article, we proposed aligning migrations with the CakePHP/database conventions to ensure a seamless and consistent experience for developers. In this Q&A article, we'll address some of the most frequently asked questions about this proposal.

Q: What are the main reasons for aligning migrations with CakePHP conventions?

A: The main reasons for aligning migrations with CakePHP conventions are to ensure a seamless and consistent experience for developers, simplify the migration process, and reduce the risk of issues when working with different database dialects.

Q: What types are being deprecated or removed in this proposal?

A: The following types are being deprecated or removed in this proposal:

enum: Currently, migrations support the enum type, but it's not directly supported in CakePHP. Instead, we recommend using varchar columns with mapped types.
set: Similar to enum, the set type is not supported in CakePHP and can be replaced with varchar columns.
inet: The inet type is not supported in CakePHP and can be shimmed with a compatibility layer.
macaddr: The macaddr type is not supported in CakePHP and can be shimmed with a compatibility layer.
interval: The interval type is not supported in CakePHP and can be shimmed with a compatibility layer.
filestream: The filestream type is not supported in CakePHP and can be shimmed with a compatibility layer.

Q: What about the `jsonb` type in Postgres? Is it being deprecated or removed?

A: The jsonb type in Postgres is not being deprecated or removed. However, it's not directly supported in CakePHP, and we recommend using a compatibility layer to shim it.

Q: What about the `AdapterInterface::PHINX_TYPE_*` constants? Are they being deprecated or removed?

A: Yes, the AdapterInterface::PHINX_TYPE_* constants are being deprecated and removed in favor of the CakePHP ones.

Q: What about the datetime and timestamp types? Are they being changed?

A: Yes, the datetime and timestamp types are being aligned with CakePHP conventions. This will result in different types being used in migration and dump files.

Q: What about backward compatibility? How will this proposal affect existing migrations?

A: This proposal will result in some minor breaking changes as the semantics of existing migrations would change. However, we'll provide a compatibility layer to shim the deprecated types, ensuring that existing migrations continue to work as expected.

Q: What about the timeline for implementing this proposal?

A: We propose implementing this proposal in the next major release of CakePHP (4.7). We'll provide a detailed roadmap and timeline for implementing the changes.

Q: How can I provide feedback or contribute to this proposal?

A: We welcome feedback and contributions from the community. You can provide feedback or contribute to this proposal by commenting on this RFC or submitting a pull request to the CakePHP repository.

Conclusion

Aligning migrations with the CakePHP/database conventions is a crucial step in ensuring a seamless and consistent experience for developers. By deprecating and removing unsupported types, we can simplify the migration process and reduce the risk of issues when working with different database dialects. We hope this Q&A article has addressed some of the most frequently asked questions about this proposal and provided a clear understanding of the changes involved.