SQL DDL documentation by ahmedabu98 · Pull Request #37539 · apache/beam

ahmedabu98 · 2026-02-06T21:44:06Z

https://apache-beam-website-pull-requests.storage.googleapis.com/37539/documentation/dsls/sql/ddl/index.html

Adding some SQL DDL documentation to the Beam website.

Specifically the following commands for Catalogs, Databases, Tables:

CREATE
DROP
USE
SHOW
ALTER

…erg_getting_started

gemini-code-assist · 2026-02-06T21:44:30Z

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.

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 · 2026-02-06T22:42:49Z

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

…erg_getting_started

github-actions · 2026-02-17T21:46:07Z

Assigning reviewers:

R: @kennknowles for label java.
R: @shunping for label website.

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

stop reviewer notifications - opt out of the automated review tooling
remind me after tests pass - tag the comment author after tests pass
waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

github-actions · 2026-02-27T12:23:32Z

Reminder, please take a look at this pr: @kennknowles @shunping

github-actions · 2026-03-05T12:25:53Z

Assigning new set of reviewers because Pr has gone too long without review. If you would like to opt out of this review, comment assign to next reviewer:

R: @Abacn for label java.
R: @Abacn for label website.

Available commands:

stop reviewer notifications - opt out of the automated review tooling
remind me after tests pass - tag the comment author after tests pass
waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

github-actions · 2026-03-19T12:26:36Z

Reminder, please take a look at this pr: @Abacn

github-actions · 2026-03-23T12:30:07Z

Assigning new set of reviewers because Pr has gone too long without review. If you would like to opt out of this review, comment assign to next reviewer:

R: @chamikaramj for label java.
R: @kennknowles for label website.

Available commands:

stop reviewer notifications - opt out of the automated review tooling
remind me after tests pass - tag the comment author after tests pass
waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

github-actions · 2026-03-30T12:35:03Z

Reminder, please take a look at this pr: @chamikaramj @kennknowles

Abacn · 2026-03-30T15:13:30Z

@ahmedabu98 are you still waiting for @talatuyarer review, or want anther reviewer to take a look

ahmedabu98 · 2026-03-30T16:43:35Z

I could use another reviewer, looks like @talatuyarer may have their hands full

github-actions · 2026-04-09T12:38:25Z

Reminder, please take a look at this pr: @chamikaramj @kennknowles @Abacn

github-actions · 2026-04-13T12:39:37Z

Assigning new set of reviewers because Pr has gone too long without review. If you would like to opt out of this review, comment assign to next reviewer:

R: @chamikaramj for label java.
R: @shunping for label website.

Available commands:

stop reviewer notifications - opt out of the automated review tooling
remind me after tests pass - tag the comment author after tests pass
waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

Abacn

For markdown, could you please find a tech writer reviewer? Thanks!

Abacn · 2026-04-14T01:20:59Z

+        if (prop.equals(TRIGGERING_FREQUENCY_FIELD)) {
+          this.triggeringFrequency = property.getValue().asInt();
+        } else {
+          throw new IllegalArgumentException("Unknown Beam write property: " + name);


Would it be preferred to warn here (for future forward and backward compatibility)

I'd rather fail and avoid a situation where the transform is behaving unexpectedly.

I remember running into user issues with some IOs for the same reason, where incorrect configurations were logged but the pipeline kept running.

github-actions · 2026-04-21T12:38:00Z

Reminder, please take a look at this pr: @chamikaramj @shunping

github-actions · 2026-04-24T12:36:35Z

Assigning new set of reviewers because Pr has gone too long without review. If you would like to opt out of this review, comment assign to next reviewer:

R: @Abacn for label java.
R: @Abacn for label website.

Available commands:

stop reviewer notifications - opt out of the automated review tooling
remind me after tests pass - tag the comment author after tests pass
waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

Abacn · 2026-04-24T13:58:31Z

waiting on author

…erg_getting_started

shuesc1

Good overall, just some misc. nits.

shuesc1 · 2026-05-06T16:51:09Z

Should there be a section/link added to this page for this new content?

https://apache-beam-website-pull-requests.storage.googleapis.com/37539/documentation/dsls/sql/overview/index.html

shuesc1 · 2026-05-06T20:13:09Z

+
+# Beam SQL DDL
+
+Beam SQL provides a standard three-level hierarchy to manage metadata across external data sources,


For SEO purposes and to orient the reader it's a good idea to introduce the notion of Beam SQL DDL here. Something like: "Beam SQL Data Definition Language (DDL) provides..." (or similar).

shuesc1 · 2026-05-06T20:18:10Z

+# Beam SQL DDL
+
+Beam SQL provides a standard three-level hierarchy to manage metadata across external data sources,
+enabling structured discovery and cross-source interoperability.


"enabling structured discovery and cross-source interoperability": this reads a little bit like marketing speak to me and is a bit vague. Could you rephrase more in terms of what it allows them as the user to do?

Like: "...external data sources. This lets you discover data trends in a structured way and operate using multiple data sources" (or something).

shuesc1 · 2026-05-06T20:20:25Z

+
+Beam SQL provides a standard three-level hierarchy to manage metadata across external data sources,
+enabling structured discovery and cross-source interoperability.
+1. Catalog: The top-level container representing an external metadata provider. Examples include a Hive Metastore, AWS Glue, or a BigLake Catalog.


BigLake Catalog -> Lakehouse (formerly BigLake) Catalog

shuesc1 · 2026-05-06T20:22:19Z

+Beam SQL provides a standard three-level hierarchy to manage metadata across external data sources,
+enabling structured discovery and cross-source interoperability.
+1. Catalog: The top-level container representing an external metadata provider. Examples include a Hive Metastore, AWS Glue, or a BigLake Catalog.
+2. Database: A logical grouping within a Catalog. This typically maps to a "Schema" in traditional RDBMS or a "Namespace" in systems like Apache Iceberg


add period at end to match other list items: "...systems like Apache Iceberg."

shuesc1 · 2026-05-06T21:03:24Z

+  [ TBLPROPERTIES 'properties_json_string' ];
+{{< /highlight >}}
+<ul>
+  <li><strong>TYPE:</strong> the table type (e.g. <code>'iceberg'</code>, <code>'text'</code>, <code>'kafka'</code>).</li>


(e.g. 'iceberg', 'text', 'kafka') -> (for example, 'iceberg', 'text', 'kafka')

Side note: is this list exhaustive?

shuesc1 · 2026-05-06T21:04:08Z

+<ul>
+  <li><strong>TYPE:</strong> the table type (e.g. <code>'iceberg'</code>, <code>'text'</code>, <code>'kafka'</code>).</li>
+  <li><strong>PARTITIONED BY:</strong> an ordered list of fields describing the partition spec.</li>
+  <li><strong>LOCATION:</strong> explicitly sets the location of the table (overriding the inferred <code>catalog.db.table_name</code> location)</li>


of the table (overriding the inferred catalog.db.table_name location) -> of the table. This overrides the inferred catalog.db.table_name location.

shuesc1 · 2026-05-06T21:05:15Z

+<ul>
+  <li>This creates an Iceberg table named <code>orders</code> under the namespace <code>sales_data</code>, within the <code>prod_iceberg</code> catalog.</li>
+  <li>The table is partitioned by <code>region_id</code>, then by the day value of <code>order_date</code> (using Iceberg's <a href="https://iceberg.apache.org/docs/latest/partitioning/#icebergs-hidden-partitioning">hidden partitioning</a>).</li>
+  <li>The table is created with the appropriate properties <code>"write.format.default"</code> and <code>"read.split.target-size"</code>. The Beam property <code>"beam.write.triggering_frequency_seconds"</code></li>


Hanging thought: "The Beam property "beam.write.triggering_frequency_seconds""

shuesc1 · 2026-05-06T21:05:51Z

+  <li>This creates an Iceberg table named <code>orders</code> under the namespace <code>sales_data</code>, within the <code>prod_iceberg</code> catalog.</li>
+  <li>The table is partitioned by <code>region_id</code>, then by the day value of <code>order_date</code> (using Iceberg's <a href="https://iceberg.apache.org/docs/latest/partitioning/#icebergs-hidden-partitioning">hidden partitioning</a>).</li>
+  <li>The table is created with the appropriate properties <code>"write.format.default"</code> and <code>"read.split.target-size"</code>. The Beam property <code>"beam.write.triggering_frequency_seconds"</code></li>
+  <li>Beam properties (prefixed with <code>"beam.write."</code> and <code>"beam.read."</code> are intended for the relevant IOs)</li>


Confusing wording-- can you rephrase?

shuesc1 · 2026-05-06T21:06:37Z

+
+{{< /tab >}}
+{{< tab SHOW >}}
+<p>Lists tables under the currently active database, or a specified database.</p>


or a specified database. -> or a database you specify.

talatuyarer and others added 2 commits September 30, 2025 00:46

create catalog and iceberg table details

b52c85f

Merge branch 'master' of https://github.com/ahmedabu98/beam into iceb…

092ea3e

…erg_getting_started

github-actions Bot added java website io extensions sql labels Feb 6, 2026

add sql ddl website documentation

257cd5a

ahmedabu98 force-pushed the iceberg_getting_started branch from f2675e8 to 257cd5a Compare February 6, 2026 21:47

add links

0d6ea98

ahmedabu98 added 2 commits February 8, 2026 15:10

spotless

aa5d701

Merge branch 'master' of https://github.com/ahmedabu98/beam into iceb…

5ff507c

…erg_getting_started

github-actions Bot added the Next Action: Reviewers label Feb 17, 2026

talatuyarer reviewed Feb 20, 2026

View reviewed changes

Comment thread website/www/site/content/en/documentation/dsls/sql/ddl/create.md Outdated

Comment thread website/www/site/content/en/documentation/dsls/sql/ddl/overview.md Outdated

Comment thread website/www/site/content/en/documentation/dsls/sql/ddl/overview.md Outdated

github-actions Bot added the slow-review label Feb 27, 2026

address comments

936aa38

github-actions Bot added reassigned-reviewers and removed slow-review labels Mar 5, 2026

ahmedabu98 added 4 commits March 10, 2026 12:04

fix links

ca726e5

extra description for databases and tables

2c8eb94

make prettier

4546446

cleanup

9451dde

github-actions Bot added the slow-review label Mar 19, 2026

github-actions Bot removed the slow-review label Mar 23, 2026

github-actions Bot added the slow-review label Mar 30, 2026

github-actions Bot removed the slow-review label Mar 30, 2026

Abacn self-requested a review April 1, 2026 19:42

github-actions Bot added the slow-review label Apr 9, 2026

github-actions Bot removed the slow-review label Apr 13, 2026

Abacn reviewed Apr 14, 2026

View reviewed changes

github-actions Bot added the slow-review label Apr 21, 2026

Abacn added Next Action: Author and removed Next Action: Reviewers labels Apr 21, 2026

github-actions Bot removed the slow-review label Apr 24, 2026

address comments

24c459c

github-actions Bot added Next Action: Reviewers and removed Next Action: Author labels May 5, 2026

Merge branch 'master' of https://github.com/ahmedabu98/beam into iceb…

2e4a3a3

…erg_getting_started

shuesc1 reviewed May 6, 2026

View reviewed changes


		# Beam SQL DDL

		Beam SQL provides a standard three-level hierarchy to manage metadata across external data sources,

Conversation

ahmedabu98 commented Feb 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gemini-code-assist Bot commented Feb 6, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

github-actions Bot commented Feb 6, 2026

Uh oh!

github-actions Bot commented Feb 17, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Feb 27, 2026

Uh oh!

github-actions Bot commented Mar 5, 2026

Uh oh!

github-actions Bot commented Mar 19, 2026

Uh oh!

github-actions Bot commented Mar 23, 2026

Uh oh!

github-actions Bot commented Mar 30, 2026

Uh oh!

Abacn commented Mar 30, 2026

Uh oh!

ahmedabu98 commented Mar 30, 2026

Uh oh!

github-actions Bot commented Apr 9, 2026

Uh oh!

github-actions Bot commented Apr 13, 2026

Uh oh!

Abacn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Apr 21, 2026

Uh oh!

github-actions Bot commented Apr 24, 2026

Uh oh!

Abacn commented Apr 24, 2026

Uh oh!

shuesc1 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

ahmedabu98 commented Feb 6, 2026 •

edited

Loading