docs: document Additional Table Create SQL for creating indexes#2679
Open
docs: document Additional Table Create SQL for creating indexes#2679
Conversation
Contributor
Author
|
The additional_table_create_sql binding property exists on several SQL materializations but lacks guidance on practical use cases. This has caused confusion in support — even internally — about what the field does. Add a usage section with index creation examples to the PostgreSQL and Databricks materialization docs. For Databricks, also add the missing property to the bindings reference table. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
jwhartley
force-pushed
the
docs/additional-table-create-sql
branch
from
0ee5941 to
de0ccfb
Compare
aeluce
approved these changes
Feb 18, 2026
Collaborator
aeluce
left a comment
aeluce
left a comment
There was a problem hiding this comment.
LGTM. Did you want to update the Postgres materialization variants as well? If you didn't want to copy the new section to all of them, you could add a link to the binding property directed to the "Additional Table Create SQL" section in the main Postgres doc.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
additional_table_create_sqlbinding property for creating indexesadditional_table_create_sqlproperty to the Databricks materialization docs bindings table, with a similar usage sectionCREATE INDEXexample (Postgres) and notes about when the SQL executesContext
This field exists in config reference tables for Postgres-family connectors but the description ("Additional SQL statement(s) to be run in the same transaction that creates the table") doesn't make practical use cases obvious. The only existing usage example is on the TimescaleDB page (for hypertables).
A recent support thread showed this is a common source of confusion — customers aren't sure what the field is for or how to use it for things like creating indexes. Adding concrete examples should reduce repeat questions.
The Databricks connector also implements the field but it was missing from the docs entirely.
Test plan
🤖 Generated with Claude Code