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.

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

Fix "bigint" type introspection for PK column with AI for SQLite #6411

Open
wants to merge 1 commit into
base: 3.9.x
Choose a base branch
from

Conversation

mvorisek
Copy link
Contributor

@mvorisek mvorisek commented May 28, 2024

Q A
Type bug
Fixed issues #6396

Summary

Because SQLite does not support AUTOINCREMENT keyword on any other type than INTEGER [1] [2], bigint type is mapped to INTEGER SQLite database column by DBAL already [3].

As we remap the type on table creation, we need to remap the type also on table introspection. The reason, we remap integer to bigint, is bigint is subtype of integer - PK defined/created originally as bigint must be always introspected as bigint.

[1] https://www.sqlite.org/autoinc.html
[2] https://dbfiddle.uk/yyXvHV-6
[3] https://github.com/doctrine/dbal/blob/3.8.4/src/Platforms/SqlitePlatform.php#L271-L274

@mvorisek mvorisek changed the title Fix "bigint" type for PK with AI introspection for SQLite Fix "bigint" type introspection for PK column with AI for SQLite May 28, 2024
@mvorisek mvorisek force-pushed the fix_sqlite_bigint_pk_introspect branch from 9352375 to b6a65d9 Compare May 29, 2024 10:28
@mvorisek mvorisek mentioned this pull request May 31, 2024
Copy link
Member

@greg0ire greg0ire left a comment

Choose a reason for hiding this comment

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

It would seem that this is going to cause the opposite problem: a primary key with type INTEGER is wrongly going to be introspected as BIGINT, isn't it?

@@ -379,6 +379,12 @@ protected function _getPortableTableColumnDefinition($tableColumn)
$default = null;
}

// https://github.com/doctrine/dbal/blob/3.8.4/src/Platforms/SqlitePlatform.php#L271-L274
// https://dbfiddle.uk/yyXvHV-6
if (strtolower($type) === 'integer' && ($tableColumn['pk'] !== 0 && $tableColumn['pk'] !== '0')) {
Copy link
Member

Choose a reason for hiding this comment

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

I don't understand why $tableColumn['pk'] !== 0 && $tableColumn['pk'] !== '0' should mean this is an auto increment column. Couldn't it be an integer column that is part of the primary key?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I coded the "auto increment" detection based on existing https://github.com/doctrine/dbal/blob/b6a65d9ef8/src/Schema/SqliteSchemaManager.php#L295-L319. Is that right?

Copy link
Member

Choose a reason for hiding this comment

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

I also noticed that code block, but I don't know why it is right (if it is).

@mvorisek
Copy link
Contributor Author

mvorisek commented Jun 2, 2024

It would seem that this is going to cause the opposite problem: a primary key with type INTEGER is wrongly going to be introspected as BIGINT, isn't it?

This is unavoidable because of #5107 and expected - INT is subtype of BIGINT, so BIGINT must be introspected because of https://github.com/doctrine/dbal/blob/3.8.4/src/Platforms/SqlitePlatform.php#L271-L274 transformation done when creating the table.

@remco-pc
Copy link

remco-pc commented Jun 4, 2024

The auto increment are in the sequence table and these are integers probably. You could select from this table to check if there is auto increment.

@mvorisek
Copy link
Contributor Author

mvorisek commented Jun 5, 2024

Is it really wanted to do additional query in _getPortableTableColumnDefinition method?

@derrabus
Copy link
Member

I'm not comfortable with merging this change into 3.8, tbh.

As you've already noticed, SQLite's implementation of integer PKs is a bit odd. The main issue is that SQLite does not allow you to create BIGINT PKs which is why the DBAL creates an INTEGER PRIMARY KEY column instead which has the value range of a BIGINT.

This also means that when introspecting, we cannot tell the difference between a column that was created by DBAL from a IntegerType and one that was created from a BigIntType. This is why the DBAL guesses one of two possible types. Apparently the wrong one in your case. Your "fix" would simply change that guess to a different one. That guess is not more accurate that the currently implemented one. It's just wrong for a different group of apps.

@remco-pc
Copy link

remco-pc commented Jul 16, 2024

You could also solve this in documentation: say in sqlite primary keys are just ints, not bigints and do nothing about the code or throw an exception when a primary key is not an int in sqlite

@derrabus
Copy link
Member

throw an exception when a primary key is not an int in sqlite

We probably don't want this. If someone uses BIGINT PKs on their entity model, e.g. because they're using MySQL in production, they should still be able to deploy their model to SQLite for testing purposes.

@remco-pc
Copy link

Yes and testing a big int number will fail

@SenseException
Copy link
Member

I think the point was that it shouldn't fail. Prod uses MySQL and a Test environment SQLite. It would break projects if SQLite would suddenly throw an exception. If it would stay that way, I wouldn't expect such a change in 3.8 or 4.0.

@derrabus derrabus changed the base branch from 3.8.x to 3.9.x August 14, 2024 10:52
Copy link

There hasn't been any activity on this pull request in the past 90 days, so it has been marked as stale and it will be closed automatically if no further activity occurs in the next 7 days.
If you want to continue working on it, please leave a comment.

@github-actions github-actions bot added the Stale label Nov 13, 2024
@mvorisek
Copy link
Contributor Author

I will work on this.

@derrabus derrabus removed the Stale label Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants