azimuttapp / azimutt

Explore, document and optimize any database
https://azimutt.app
MIT License
1.35k stars 87 forks source link

Create PostgreSQL parser #327

Closed loicknuchel closed 1 week ago

loicknuchel commented 1 month ago

Summary by CodeRabbit

coderabbitai[bot] commented 3 weeks ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The pull request introduces several changes across multiple files, primarily enhancing the PostgreSQL parsing capabilities within the application. Key modifications include updates to the converters function to enable parsing for PostgreSQL, adjustments in HTML templates to support PostgreSQL syntax, and the addition of new SQL types and structures in the schema. Furthermore, a comprehensive SQL parser for PostgreSQL is implemented, along with corresponding tests to ensure functionality. This broad set of changes aims to improve the handling of PostgreSQL within the system.

Changes

File Path Change Summary
backend/lib/azimutt.ex Updated PostgreSQL converter in converters function to enable parsing (parse: true).
backend/lib/azimutt_web/templates/website/converters/_editors-script.html.heex Modified parse and format functions to support PostgreSQL syntax.
libs/aml/resources/full.aml Reordered parameters in box type definition; declared new entity social_accounts.
libs/aml/resources/full.json Reordered parameters in box type definition; no significant changes to entities.
libs/aml/resources/full.md Updated documentation for box type and clarified comments entity attributes.
libs/models/src/parserResult.ts Modified mergePositions function to filter out positions without a valid offset.
libs/parser-sql/resources/complex.postgres.sql Created new SQL file with various complex SQL statements for testing.
libs/parser-sql/resources/full.postgres.sql Removed several tables and views, created new types and tables, and reordered parameters in box type.
libs/parser-sql/src/errors.ts Added duplicated function to handle duplicate definitions in parsing errors.
libs/parser-sql/src/postgresAst.ts Introduced comprehensive TypeScript type definitions for PostgreSQL AST.
libs/parser-sql/src/postgresBuilder.test.ts Added tests for the postgresBuilder module, covering various SQL parsing scenarios.
libs/parser-sql/src/postgresBuilder.ts Implemented functions for parsing PostgreSQL statements and building database representations.
libs/parser-sql/src/postgresParser.test.ts Created unit tests for the parsePostgresAst function, covering multiple SQL command types.
libs/parser-sql/src/postgresParser.ts Developed a PostgreSQL-specific SQL parser using Chevrotain, with rules for various SQL statements.
libs/parser-sql/src/sql.ts Updated parsing and generation functions to handle PostgreSQL dialect.
libs/utils/src/array.ts Added distinctBy function for filtering distinct elements in an array.
libs/aml/src/amlParser.ts Updated pos function to use Number.isNaN for checking NaN values.

Possibly related PRs

🐰 In the land of code where the rabbits play,
PostgreSQL parsing has brightened the day!
With functions and types all in a row,
Our SQL skills now have room to grow.
Hopping through scripts, so clever and spry,
Watch as our queries reach for the sky! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `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 generate unit testing code for this file.` - `@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 generate unit testing code.` - `@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.` 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.