Skip to content

feat: allow auto increment to be set through Blueprint #276

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

taka-oyama
Copy link
Collaborator

@taka-oyama taka-oyama commented May 9, 2025

#273 and #275 needs to be fixed for analyze to pass.

@taka-oyama taka-oyama requested a review from a team May 9, 2025 04:00
@taka-oyama taka-oyama self-assigned this May 9, 2025
@taka-oyama taka-oyama added the enhancement New feature or request label May 9, 2025
Copy link

coderabbitai bot commented May 9, 2025

Warning

Rate limit exceeded

@taka-oyama has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 12 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 6da79b4 and e61e815.

📒 Files selected for processing (1)
  • README.md (1 hunks)

Walkthrough

The Docker image version for the emulator service was updated. Support for auto-incrementing big integer columns was added, including changes to the schema blueprint, grammar, and column definition annotations to handle the autoIncrement flag. A new method setDatabaseOptions was introduced in the schema builder to configure database-level options. Tests were added to verify the creation and behavior of auto-increment columns. The database setup was modified to set the default sequence kind option. Documentation was updated to clarify how to explicitly use auto-increment columns in Google Cloud Spanner.

Possibly related PRs


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@taka-oyama taka-oyama marked this pull request as draft May 12, 2025 02:12
@taka-oyama taka-oyama marked this pull request as ready for review May 21, 2025 06:40
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
tests/TestCase.php (1)

147-152: Database option setup looks good but could benefit from documentation.

The new code correctly sets the default_sequence_kind option to bit_reversed_positive immediately after database creation, which supports the auto-increment functionality introduced in this PR. This setting is necessary for proper operation of auto-incrementing columns in Spanner.

Consider adding a brief comment explaining why this specific database option is being set, which would help future maintainers understand its purpose and significance in the test environment.

$conn->createDatabase($this->getTestDatabaseDDLs());

+ // Configure database to use bit-reversed sequences for auto-increment columns
$conn->getSchemaBuilder()->setDatabaseOptions([
    'default_sequence_kind' => 'bit_reversed_positive',
]);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 8c588c9 and 986fb28.

📒 Files selected for processing (4)
  • src/Schema/Builder.php (2 hunks)
  • src/Schema/Grammar.php (2 hunks)
  • tests/Schema/BlueprintTest.php (1 hunks)
  • tests/TestCase.php (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • tests/Schema/BlueprintTest.php
  • src/Schema/Builder.php
  • src/Schema/Grammar.php
🧰 Additional context used
🧬 Code Graph Analysis (1)
tests/TestCase.php (2)
src/Connection.php (1)
  • getSchemaBuilder (221-228)
src/Schema/Builder.php (1)
  • setDatabaseOptions (49-60)

Copy link
Contributor

@halnique halnique left a comment

Choose a reason for hiding this comment

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

Shouldn't the following section of README.md be modified/updated/revised?

Migrations

Since Cloud Spanner does not support AUTO_INCREMENT attribute, Blueprint::increments (and all of its variants) will create a column of type STRING(36) DEFAULT (GENERATE_UUID()) to generate and fill the column with a UUID and flag it as a primary key.

@taka-oyama taka-oyama force-pushed the feat/blueprint-auto-increment branch from 794be3c to 6da79b4 Compare May 23, 2025 04:47
@taka-oyama
Copy link
Collaborator Author

Thank you for reminding about the README. It has been updated.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
README.md (1)

113-121: Document setDatabaseOptions for sequence configuration
Since the PR introduces setDatabaseOptions in the schema builder to control database-level sequence settings, it would be helpful to show users how to enable or customize auto-increment behavior. For example, add before the create call:

 $schemaBuilder = app(\Illuminate\Database\Schema\Builder::class);
+// Configure database options for auto-increment sequences
+$schemaBuilder->setDatabaseOptions([
+    'sequenceOptions' => [
+        'sequenceKind'      => 'PROVISIONAL',
+        'startWithCounter'  => 1,
+    ],
+]);
 $schemaBuilder->create('user', function (Blueprint $table) {
     $table->integer('id')->primary()->autoIncrement();
 });

This clarifies how to adjust the underlying Spanner sequence settings when using autoIncrement().

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 794be3c and 6da79b4.

📒 Files selected for processing (9)
  • README.md (1 hunks)
  • compose.yaml (1 hunks)
  • src/Schema/Blueprint.php (1 hunks)
  • src/Schema/Builder.php (2 hunks)
  • src/Schema/ColumnDefinition.php (1 hunks)
  • src/Schema/Grammar.php (2 hunks)
  • src/Schema/IntColumnDefinition.php (0 hunks)
  • tests/Schema/BlueprintTest.php (1 hunks)
  • tests/TestCase.php (1 hunks)
💤 Files with no reviewable changes (1)
  • src/Schema/IntColumnDefinition.php
🚧 Files skipped from review as they are similar to previous changes (7)
  • tests/TestCase.php
  • compose.yaml
  • src/Schema/Blueprint.php
  • src/Schema/Builder.php
  • src/Schema/ColumnDefinition.php
  • src/Schema/Grammar.php
  • tests/Schema/BlueprintTest.php
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Run-PHPUnit
🔇 Additional comments (1)
README.md (1)

113-121: Ensure correct column type for auto-increment
The AI summary and implementation focus on big integer auto-increment support. The example uses $table->integer('id'), which in Laravel typically maps to a 32-bit column. To match Spanner’s 64-bit integer and the added big integer auto-increment feature, the snippet should use:

-   $table->integer('id')->primary()->autoIncrement();
+   $table->bigInteger('id')->primary()->autoIncrement();

Please verify the intended Blueprint API and update the documentation accordingly.

Likely an incorrect or invalid review comment.

@taka-oyama taka-oyama requested a review from halnique May 23, 2025 04:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request waiting for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants