SQL DDL documentation

[ahmedabu98]

Adding some SQL DDL documentation to the Beam website.

Specifically the following commands for Catalogs, Databases, Tables:

• CREATE
• DROP
• USE
• SHOW
• ALTER

[gemini-code-assist]

Summary of Changes

Hello @ahmedabu98, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the Apache Beam website by introducing extensive documentation for SQL Data Definition Language (DDL) commands, making it easier for users to understand and utilize SQL for managing Catalogs, Databases, and Tables. Concurrently, it refines the Iceberg SQL connector's ability to handle table properties, including a new convention for Beam-specific configurations, and updates existing documentation to reflect these capabilities and new table types.

Highlights

• New SQL DDL Documentation: Comprehensive documentation has been added for Beam SQL Data Definition Language (DDL) commands, covering CREATE, DROP, USE, SHOW, and ALTER statements for Catalogs, Databases, and Tables.
• Iceberg Connector Enhancements: The Iceberg SQL connector has been updated to support passing table properties during table creation and to correctly parse Beam-specific properties (prefixed with 'beam.write.' and 'beam.read.').
• Website Navigation Update: The Beam website's navigation menu has been updated to include a new 'DDL' section under Beam SQL, providing easy access to the newly added documentation.
• Expanded CREATE EXTERNAL TABLE Documentation: The documentation for CREATE EXTERNAL TABLE now includes detailed sections for Iceberg and DataGen table types, explaining their syntax, properties, and usage.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• sdks/java/extensions/sql/iceberg/src/main/java/org/apache/beam/sdk/extensions/sql/meta/provider/iceberg/IcebergMetastore.java
  • Added imports for Collectors and TypeReference.
  • Modified createTable method to accept and process a Map<String, String> properties argument, filtering out Beam-specific properties before passing them to the Iceberg catalog.
• sdks/java/extensions/sql/iceberg/src/main/java/org/apache/beam/sdk/extensions/sql/meta/provider/iceberg/IcebergTable.java
  • Added import for JsonNode and defined constants for BEAM_WRITE_PROPERTY and BEAM_READ_PROPERTY.
  • Refactored the constructor to iterate through table properties, identify Beam-specific properties (e.g., beam.write.triggering_frequency_seconds), and throw exceptions for unknown Beam properties.
• sdks/java/extensions/sql/iceberg/src/test/java/org/apache/beam/sdk/extensions/sql/meta/provider/iceberg/PubsubToIcebergIT.java
  • Updated TBLPROPERTIES in test cases to use the new beam.write.triggering_frequency_seconds prefix for triggering_frequency_seconds.
• sdks/java/io/iceberg/src/main/java/org/apache/beam/sdk/io/iceberg/IcebergCatalogConfig.java
  • Modified createTable method signature to include a Map<String, String> properties argument.
  • Passed the new properties argument to the underlying Iceberg catalog().createTable call.
• website/www/site/content/en/documentation/dsls/sql/ddl/alter.md
  • Added new documentation for ALTER CATALOG and ALTER TABLE statements, including examples for column, partition, and property modifications.
• website/www/site/content/en/documentation/dsls/sql/ddl/create.md
  • Added new documentation for CREATE CATALOG, CREATE DATABASE, and CREATE TABLE statements, with examples for Iceberg catalog and table creation, including Beam-specific properties.
• website/www/site/content/en/documentation/dsls/sql/ddl/drop.md
  • Added new documentation for DROP CATALOG, DROP DATABASE, and DROP TABLE statements, explaining unregistration versus physical deletion.
• website/www/site/content/en/documentation/dsls/sql/ddl/overview.md
  • Added a new overview document for Beam SQL DDL, explaining the three-tier namespace (Catalog, Database, Table) and linking to specific DDL command documentation.
• website/www/site/content/en/documentation/dsls/sql/ddl/show.md
  • Added new documentation for SHOW CATALOGS, SHOW DATABASES, and SHOW TABLES statements, including examples for filtering and checking current context.
• website/www/site/content/en/documentation/dsls/sql/ddl/use.md
  • Added new documentation for USE CATALOG and USE DATABASE statements, explaining how to set the active context.
• website/www/site/content/en/documentation/dsls/sql/extensions/create-catalog.md
  • Added detailed documentation for CREATE CATALOG specifically for Apache Iceberg, covering syntax, required/optional properties for various catalog implementations (Hadoop, BigQuery, JDBC), and examples. Includes sections on using catalogs, management, best practices, and troubleshooting.
• website/www/site/content/en/documentation/dsls/sql/extensions/create-external-table.md
  • Modified to include iceberg and datagen as supported TYPE values in the CREATE EXTERNAL TABLE syntax.
  • Added a new comprehensive section for Apache Iceberg table creation, covering syntax, read/write modes, schema mapping, and examples.
• website/www/site/layouts/partials/section-menu/en/sdks.html
  • Modified to add a new collapsible 'DDL' section under 'Beam SQL' in the navigation menu, linking to the newly added DDL documentation pages.

Activity

• ahmedabu98 created this pull request to add SQL DDL documentation to the Beam website.
• The changes include adding new markdown files for DDL commands (ALTER, CREATE, DROP, OVERVIEW, SHOW, USE) and a detailed create-catalog.md.
• Existing Java code for Iceberg SQL integration was modified to support new table properties and their parsing.
• Test cases for Iceberg were updated to reflect the new property naming conventions.
• The website's navigation menu was updated to incorporate the new DDL documentation structure.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[github-actions]

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers