DDL Support: Tracking Issue

sqlfmt was made for dbt, and originally only formatted select statements. Additional syntax is being added all the time. The list below represents the current functionality of sqlfmt @main. To request prioritization of additional commands/statements, leave a comment below or open an issue.

Commands marked below with (no handling) are simple enough to be lexed/formatted with sqlfmt's core engine.

Relevant releases (see the Changelog for more info):

0.12: Detects DDL and does not format unsupported statements (prior versions would apply incorrect formatting). Adds support for values
0.13: Adds support for delete, grant, revoke, create function, and explain
0.14: Adds support for create warehouse, alter warehouse, alter function, drop function, create external function
0.15: Adds support for create <object> ... clone statements

The full list of PostgreSQL SQL Commands:

[x] ABORT — abort the current transaction. (No handling)
[ ] ALTER AGGREGATE — change the definition of an aggregate function
[ ] ALTER COLLATION — change the definition of a collation
[ ] ALTER CONVERSION — change the definition of a conversion
[ ] ALTER DATABASE — change a database
[ ] ALTER DEFAULT PRIVILEGES — define default access privileges
[ ] ALTER DOMAIN — change the definition of a domain
[ ] ALTER EVENT TRIGGER — change the definition of an event trigger
[ ] ALTER EXTENSION — change the definition of an extension
[ ] ALTER FOREIGN DATA WRAPPER — change the definition of a foreign-data wrapper
[ ] ALTER FOREIGN TABLE — change the definition of a foreign table
[ ] #310
[ ] ALTER GROUP — change role name or membership
[ ] ALTER INDEX — change the definition of an index
[ ] ALTER LANGUAGE — change the definition of a procedural language
[ ] ALTER LARGE OBJECT — change the definition of a large object
[ ] ALTER MATERIALIZED VIEW — change the definition of a materialized view
[ ] ALTER OPERATOR — change the definition of an operator
[ ] ALTER OPERATOR CLASS — change the definition of an operator class
[ ] ALTER OPERATOR FAMILY — change the definition of an operator family
[ ] ALTER POLICY — change the definition of a row-level security policy
[ ] ALTER PROCEDURE — change the definition of a procedure
[ ] ALTER PUBLICATION — change the definition of a publication
[ ] ALTER ROLE — change a database role
[ ] ALTER ROUTINE — change the definition of a routine
[ ] ALTER RULE — change the definition of a rule
[ ] ALTER SCHEMA — change the definition of a schema
[ ] ALTER SEQUENCE — change the definition of a sequence generator
[ ] ALTER SERVER — change the definition of a foreign server
[ ] ALTER STATISTICS — change the definition of an extended statistics object
[ ] ALTER SUBSCRIPTION — change the definition of a subscription
[ ] ALTER SYSTEM — change a server configuration parameter
[ ] #314
[ ] ALTER TABLESPACE — change the definition of a tablespace
[ ] ALTER TEXT SEARCH CONFIGURATION — change the definition of a text search configuration
[ ] ALTER TEXT SEARCH DICTIONARY — change the definition of a text search dictionary
[ ] ALTER TEXT SEARCH PARSER — change the definition of a text search parser
[ ] ALTER TEXT SEARCH TEMPLATE — change the definition of a text search template
[ ] ALTER TRIGGER — change the definition of a trigger
[ ] ALTER TYPE — change the definition of a type
[ ] ALTER USER — change a database role
[ ] ALTER USER MAPPING — change the definition of a user mapping
[ ] ALTER VIEW — change the definition of a view
[ ] ANALYZE — collect statistics about a database
[ ] BEGIN — start a transaction block
[ ] CALL — invoke a procedure
[x] CHECKPOINT — force a write-ahead log checkpoint (no handling)
[x] CLOSE — close a cursor (no handling)
[ ] CLUSTER — cluster a table according to an index
[ ] COMMENT — define or change the comment of an object
[x] COMMIT — commit the current transaction (no handling)
[x] COMMIT PREPARED — commit a transaction that was earlier prepared for two-phase commit (no handling)
[ ] COPY — copy data between a file and a table
[ ] CREATE ACCESS METHOD — define a new access method
[ ] CREATE AGGREGATE — define a new aggregate function
[ ] CREATE CAST — define a new cast
[ ] CREATE COLLATION — define a new collation
[ ] CREATE CONVERSION — define a new encoding conversion
[ ] CREATE DATABASE — create a new database
[ ] CREATE DOMAIN — define a new domain
[ ] CREATE EVENT TRIGGER — define a new event trigger
[ ] CREATE EXTENSION — install an extension
[ ] CREATE FOREIGN DATA WRAPPER — define a new foreign-data wrapper
[ ] CREATE FOREIGN TABLE — define a new foreign table
[x] CREATE FUNCTION #282
[ ] CREATE GROUP — define a new database role
[ ] CREATE INDEX — define a new index
[ ] CREATE LANGUAGE — define a new procedural language
[ ] CREATE MATERIALIZED VIEW — define a new materialized view
[ ] CREATE OPERATOR — define a new operator
[ ] CREATE OPERATOR CLASS — define a new operator class
[ ] CREATE OPERATOR FAMILY — define a new operator family
[ ] CREATE POLICY — define a new row-level security policy for a table
[ ] CREATE PROCEDURE — define a new procedure
[ ] CREATE PUBLICATION — define a new publication
[ ] CREATE ROLE — define a new database role
[ ] CREATE RULE — define a new rewrite rule
[ ] CREATE SCHEMA — define a new schema
[ ] CREATE SEQUENCE — define a new sequence generator
[ ] CREATE SERVER — define a new foreign server
[ ] CREATE STATISTICS — define extended statistics
[ ] CREATE SUBSCRIPTION — define a new subscription
[ ] #300
[ ] #301
[ ] CREATE TABLESPACE — define a new tablespace
[ ] CREATE TEXT SEARCH CONFIGURATION — define a new text search configuration
[ ] CREATE TEXT SEARCH DICTIONARY — define a new text search dictionary
[ ] CREATE TEXT SEARCH PARSER — define a new text search parser
[ ] CREATE TEXT SEARCH TEMPLATE — define a new text search template
[ ] CREATE TRANSFORM — define a new transform
[ ] CREATE TRIGGER — define a new trigger
[ ] CREATE TYPE — define a new data type
[ ] CREATE USER — define a new database role
[ ] CREATE USER MAPPING — define a new mapping of a user to a foreign server
[ ] #515
[x] DEALLOCATE — deallocate a prepared statement (no handling)
[ ] DECLARE — define a cursor
[x] DELETE — delete rows of a table #281
[x] DISCARD — discard session state (no handling)
[ ] DO — execute an anonymous code block
[ ] DROP ACCESS METHOD — remove an access method
[ ] DROP AGGREGATE — remove an aggregate function
[ ] DROP CAST — remove a cast
[ ] DROP COLLATION — remove a collation
[ ] DROP CONVERSION — remove a conversion
[ ] DROP DATABASE — remove a database
[ ] DROP DOMAIN — remove a domain
[ ] DROP EVENT TRIGGER — remove an event trigger
[ ] DROP EXTENSION — remove an extension
[ ] DROP FOREIGN DATA WRAPPER — remove a foreign-data wrapper
[ ] DROP FOREIGN TABLE — remove a foreign table
[x] #311
[ ] DROP GROUP — remove a database role
[ ] DROP INDEX — remove an index
[ ] DROP LANGUAGE — remove a procedural language
[ ] DROP MATERIALIZED VIEW — remove a materialized view
[ ] DROP OPERATOR — remove an operator
[ ] DROP OPERATOR CLASS — remove an operator class
[ ] DROP OPERATOR FAMILY — remove an operator family
[ ] DROP OWNED — remove database objects owned by a database role
[ ] DROP POLICY — remove a row-level security policy from a table
[ ] DROP PROCEDURE — remove a procedure
[ ] DROP PUBLICATION — remove a publication
[ ] DROP ROLE — remove a database role
[ ] DROP ROUTINE — remove a routine
[ ] DROP RULE — remove a rewrite rule
[ ] DROP SCHEMA — remove a schema
[ ] DROP SEQUENCE — remove a sequence
[ ] DROP SERVER — remove a foreign server descriptor
[ ] DROP STATISTICS — remove extended statistics
[ ] DROP SUBSCRIPTION — remove a subscription
[ ] DROP TABLE — remove a table
[ ] DROP TABLESPACE — remove a tablespace
[ ] DROP TEXT SEARCH CONFIGURATION — remove a text search configuration
[ ] DROP TEXT SEARCH DICTIONARY — remove a text search dictionary
[ ] DROP TEXT SEARCH PARSER — remove a text search parser
[ ] DROP TEXT SEARCH TEMPLATE — remove a text search template
[ ] DROP TRANSFORM — remove a transform
[ ] DROP TRIGGER — remove a trigger
[ ] DROP TYPE — remove a data type
[ ] DROP USER — remove a database role
[ ] DROP USER MAPPING — remove a user mapping for a foreign server
[ ] DROP VIEW — remove a view
[x] END — commit the current transaction (no handling)
[ ] EXECUTE — execute a prepared statement
[x] EXPLAIN — show the execution plan of a statement #280
[ ] FETCH — retrieve rows from a query using a cursor
[x] GRANT — #283
[ ] IMPORT FOREIGN SCHEMA — import table definitions from a foreign server
[ ] INSERT — create new rows in a table
[x] LISTEN — listen for a notification (no handling)
[x] LOAD — load a shared library file (no handling)
[ ] LOCK — lock a table
[ ] MERGE — conditionally insert, update, or delete rows of a table
[x] MOVE — position a cursor (no handling)
[x] NOTIFY — generate a notification (no handling)
[ ] PREPARE — prepare a statement for execution
[x] PREPARE TRANSACTION — prepare the current transaction for two-phase commit (no handling)
[ ] REASSIGN OWNED — change the ownership of database objects owned by a database role
[x] REFRESH MATERIALIZED VIEW — replace the contents of a materialized view (no handling)
[x] REINDEX — rebuild indexes (no handling)
[x] RELEASE SAVEPOINT — destroy a previously defined savepoint (no handling)
[x] RESET — restore the value of a run-time parameter to the default value (no handling)
[x] REVOKE — remove access privileges #283
[x] ROLLBACK — abort the current transaction (no handling)
[x] ROLLBACK PREPARED — cancel a transaction that was earlier prepared for two-phase commit (no handling)
[x] ROLLBACK TO SAVEPOINT — roll back to a savepoint (no handling)
[x] SAVEPOINT — define a new savepoint within the current transaction
[ ] SECURITY LABEL — define or change a security label applied to an object
[x] SELECT — retrieve rows from a table or view
[ ] SELECT INTO — define a new table from the results of a query
[x] SET — change a run-time parameter (no handling)
[x] SET CONSTRAINTS — set constraint check timing for the current transaction (no handling)
[x] SET ROLE — set the current user identifier of the current session (no handling)
[x] SET SESSION AUTHORIZATION — set the session user identifier and the current user identifier of the current session (no handling)
[x] SET TRANSACTION — set the characteristics of the current transaction (no handling)
[x] SHOW — show the value of a run-time parameter (no handling)
[x] START TRANSACTION — start a transaction block (no handling)
[ ] TRUNCATE — empty a table or set of tables (no handling)
[x] UNLISTEN — stop listening for a notification (no handling)
[ ] UPDATE — update rows of a table
[x] VACUUM — garbage-collect and optionally analyze a database (no handling)
[x] VALUES — compute a set of rows

Snowflake adds DML:

[ ] PUT
[ ] GET
[ ] LIST
[ ] REMOVE

Snowflake adds DDL

[x] DESCRIBE (no handling)
[x] USE (no handling)
[ ] ALTER ACCOUNT (account administrators only)
[ ] ALTER SESSION (all users)
[ ] ALTER CONNECTION
[ ] ALTER NETWORK POLICY
[ ] ALTER RESOURCE MONITOR
[ ] ALTER SHARE
[x] #299
[ ] ALTER NOTIFICATION INTEGRATION
[ ] ALTER SECURITY INTEGRATION
[ ] ALTER SESSION POLICY
[ ] ALTER STORAGE INTEGRATION
[ ] ALTER EXTERNAL TABLE
[ ] ALTER MASKING POLICY
[ ] ALTER ROW ACCESS POLICY
[ ] ALTER FILE FORMAT
[ ] ALTER STAGE
[ ] ALTER PIPE
[ ] ALTER STREAM
[ ] ALTER TAG
[ ] ALTER TASK
[ ] CREATE API INTEGRATION
[ ] CREATE CONNECTION
[x] CREATE DATABASE … CLONE #313
[ ] CREATE NETWORK POLICY
[ ] CREATE NOTIFICATION INTEGRATION
[ ] CREATE RESOURCE MONITOR
[ ] CREATE SECURITY INTEGRATION
[ ] CREATE SESSION POLICY
[ ] CREATE SHARE
[ ] CREATE STORAGE INTEGRATION
[x] #312
[x] #322
[ ] CREATE EXTERNAL TABLE
[ ] CREATE FILE FORMAT
[x] CREATE FILE FORMAT … CLONE #313
[ ] CREATE MASKING POLICY
[ ] CREATE MATERIALIZED VIEW
[ ] CREATE PIPE
[ ] CREATE PROCEDURE
[ ] CREATE ROW ACCESS POLICY
[x] CREATE SCHEMA … CLONE #313
[x] CREATE SEQUENCE … CLONE #313
[ ] CREATE STAGE
[x] CREATE STAGE … CLONE #313
[ ] CREATE STREAM
[x] CREATE STREAM … CLONE #313
[x] #313
[ ] CREATE TAG
[ ] CREATE TASK
[x] CREATE TASK … CLONE #313
[ ] DROP ... (tbd if this requires any handling)

BigQuery is covered by keywords above.

Redshift adds:

[ ] ATTACH RLS POLICY
[x] CANCEL (no handling)
[x] DESC DATASHARE (no handling)
[x] DESC IDENTITY PROVIDER (no handling)
[ ] DETACH RLS POLICY
[ ] UNLOAD

Spark adds:

[x] REPAIR (no handling)
[ ] ADD FILE
[ ] ADD JAR
[ ] CACHE TABLE
[x] CLEAR CACHE (no handling)
[x] UNCACHE TABLE (no handling)

MySQL

[ ] RENAME TABLE
[ ] HANDLER
[ ] IMPORT TABLE

DuckDB

[ ] EXPORT

Materialize adds:

[ ] ALTER CLUSTER
[ ] ALTER CONNECTION
[ ] ALTER SECRET
[ ] ALTER SINK
[ ] CREATE CLUSTER
[ ] CREATE CLUSTER REPLICA
[ ] CREATE CONNECTION
[ ] CREATE SECRET
[ ] CREATE SINK

tconbeer / sqlfmt

DDL Support: Tracking Issue #262