SQL Commands

Reference index of 207 sql commands in DeltaForge: complete catalogue grouped by category, each linking to detailed syntax and examples.

api-endpoint

• ALTER API ENDPOINTModifies an existing API endpoint definition. Supports merging OPTIONS, changing the URL, changing the...
• CALL API ENDPOINTRaw preview. Issues one fetch through the same HTTP transport as INVOKE and returns unmodified response...
• CREATE API ENDPOINTDefines a single fetch endpoint under a REST API source. The endpoint knows how to fetch and write raw bytes...
• DESCRIBE API ENDPOINTShows the full stored definition of an API endpoint: URL template, response format, resolved option map...
• DROP API ENDPOINTRemoves an API endpoint definition and its run-log entries. Landed files in the storage zone are not deleted.
• INVOKE API ENDPOINTProduction fetch, writes response bodies to the connection's storage zone under a timestamped per-run...
• SHOW API ENDPOINT RUNSLists invocation history for a single API endpoint, one row per INVOKE, with run status, page/byte counts...
• SHOW API ENDPOINTSLists all API endpoint definitions, optionally filtered by owning rest_api connection and/or a LIKE pattern...

assertions

• ASSERTFirst-class assertion framework that validates query results against declarative conditions with...
• CONCURRENT BEGIN...ENDExecutes multiple SQL statements concurrently within a single block, providing cooperative parallelism with...

catalog

• ALTER TAGModifies an existing tag definition in the catalog.
• CREATE SCHEMACreates a new schema namespace within a zone.
• CREATE TAGCreates a tag definition in the catalog for data governance and classification.
• CREATE ZONECreates a new zone, the top-level namespace container in the catalog.
• DESCRIBE TAGShows detailed information about a tag definition and its assignments.
• DETECT SCHEMADiscovers and saves column schema for a registered table.
• DROP FOLDERRemoves an empty directory inside a zone's storage root (local or cloud). Refuses if the folder still has...
• DROP SCHEMADrops a schema (fails if it contains tables).
• DROP SCHEMA COLUMNSRemoves column metadata for a specific table or cleans up orphaned column records.
• DROP SCHEMA HISTORYRemoves schema evolution tracking data for a specific table.
• DROP TAGRemoves a tag definition and all of its assignments from the catalog.
• DROP ZONEDrops a zone (fails if it contains schemas).
• REGISTER DELTA TABLEPersistently registers an existing Delta table under a fully qualified zone.schema.table name. LOCATION must...
• SET TAGAssigns a tag with a value to a table, view, or column. Columns use 4-part naming: zone.schema.table.column.
• SHOW GRAPHSLists graph definitions registered in the catalog.
• SHOW SCHEMASLists schemas in the catalog, optionally filtered by zone or name pattern.
• SHOW SESSION TABLESLists all tables registered in the current compute node's session context.
• SHOW TABLESLists tables in the catalog, optionally filtered by schema or name pattern.
• SHOW TAGSLists all tag definitions in the catalog, optionally filtered by name pattern.
• SHOW ZONESLists all zones in the catalog, optionally filtered by name pattern.
• SYNC CATALOGRefreshes the compute node's permission token and catalog metadata from the control plane.
• UNREGISTER TABLERemoves a table's catalog entry without deleting the underlying data files.
• UNSET TAGRemoves a tag assignment from a table, view, or column.

configuration

• ALTER CONNECTIONModifies an existing connection: replaces options, swaps credential references, or renames.
• ALTER CREDENTIAL STORAGEModifies one or more attributes of an existing credential-storage backend: description, config options...
• ALTER EXTERNAL LOCATIONUpdates an existing external location's URL, bound credential, options, owner, or comment.
• ALTER STORAGE CREDENTIALUpdates an existing storage credential's options, owner, or comment. Replaces options atomically with the...
• ALTER VAULT / ALTER CREDENTIALModifies a vault entry: rotates encryption-key material, replaces a credential secret, updates metadata, or...
• CREATE CONNECTIONRegisters an external-system connection (database, object store, git host, SFTP, or REST API) used by schema...
• CREATE CREDENTIAL STORAGERegisters a cloud key-vault-style credential-storage backend (Azure Key Vault, AWS Secrets Manager, or GCP...
• CREATE EXTERNAL LOCATIONRegisters a storage URL bound to a storage credential as a managed external location.
• CREATE STORAGE CREDENTIALCreates a named storage credential that supplies authentication material to external locations.
• CREATE VAULT / CREATE CREDENTIALCreates a vault entry, either an encryption key (material generated by DeltaForge) or a credential...
• DESCRIBE CONNECTIONEmits metadata for a single connection. Sensitive option values are masked server-side.
• DESCRIBE CREDENTIAL STORAGEEmits metadata for a single credential-storage backend. Secret config material is never included.
• DESCRIBE EXTERNAL LOCATIONReturns the URL, credential binding, and metadata for an external location.
• DESCRIBE STORAGE CREDENTIALReturns metadata about a storage credential. Secret material is never returned.
• DESCRIBE VAULT / DESCRIBE CREDENTIALEmits metadata for a single vault entry. Secret material is never included in the output.
• DROP CONNECTIONRemoves a connection registration. External tables registered through this connection must be dropped or...
• DROP CREDENTIAL STORAGERemoves a credential-storage backend. Fails if any vault entries still reference it unless those entries are...
• DROP EXTERNAL LOCATIONRemoves an external location registration. The underlying storage and any data it contains are not touched.
• DROP STORAGE CREDENTIALRemoves a storage credential. Grants on the credential are also removed; external locations bound to the...
• DROP VAULT / DROP CREDENTIALRemoves a vault entry and wipes its backend-stored material. VAULT and CREDENTIAL are keyword aliases.
• SHOW CONNECTIONSLists all registered external connections, optionally filtered by a LIKE substring.
• SHOW CREDENTIAL STORAGESLists all registered credential-storage backends, optionally filtered by a LIKE pattern on display_name.
• SHOW EXTERNAL LOCATIONSLists all external locations, optionally filtered by a LIKE pattern.
• SHOW STORAGE CREDENTIALSLists all storage credentials, optionally filtered by a LIKE pattern.
• SHOW VAULTS / SHOW CREDENTIALSLists vault entries, optionally filtered by entry kind and a LIKE substring on display_name. VAULTS and...
• TEST CONNECTIONProbes connectivity to the external system referenced by a connection, returning success/latency/error and...
• TEST CREDENTIAL STORAGERuns the reachability probe on a credential-storage backend (the same probe executed by the GUI 'Test'...

data-loading

• COPY INTOLoads data from external files into a Delta table, with format inference, glob filtering, and idempotent...
• CREATE EXTERNAL TABLECreates an external table that references data files at a storage location, enabling SQL queries without...
• DROP EXTERNAL TABLERemoves an external table definition from the session and catalog, optionally deleting the underlying data...
• OPEN DELTA TABLEOpens an existing Delta table from a storage location and makes it queryable under a session-scoped alias...

ddl

• ALTER TABLE ADD COLUMNAdds a single column to an existing Delta table's schema.
• ALTER TABLE ADD COLUMNSAdds multiple columns to an existing Delta table in a single atomic operation.
• ALTER TABLE ADD CONSTRAINTAdds a CHECK, NOT NULL, PRIMARY KEY, or UNIQUE constraint to an existing Delta table.
• ALTER TABLE ALTER COLUMN DROP DEFAULTRemoves the default value expression from a column. INSERTs that omit the column afterward receive NULL (or...
• ALTER TABLE ALTER COLUMN DROP NOT NULLRemoves the NOT NULL constraint from a column, allowing null values.
• ALTER TABLE ALTER COLUMN SET DEFAULTSets a default value expression for a column. The expression is stored verbatim in the column's metadata and...
• ALTER TABLE ALTER COLUMN SET METADATASets or updates JSON metadata on a column for type widening tracking, custom annotations, or...
• ALTER TABLE ALTER COLUMN SET NOT NULLSets a column to NOT NULL, disallowing null values in future writes.
• ALTER TABLE ALTER COLUMN TYPEChanges the data type of an existing column via type widening. Requires the delta.enableTypeWidening table...
• ALTER TABLE CHANGE COLUMNMoves an existing column to a new position in the table schema without rewriting data files.
• ALTER TABLE CLUSTER BYConfigures or disables liquid clustering on a Delta table.
• ALTER TABLE DROP COLUMNDrops a column from a Delta table's schema using column mapping. The physical data remains in Parquet files.
• ALTER TABLE DROP CONSTRAINTDrops a named CHECK or NOT NULL constraint from a Delta table.
• ALTER TABLE RENAME COLUMNRenames an existing column in a Delta table using column mapping. The physical column name in Parquet files...
• ALTER TABLE RENAME TORenames a table in the catalog and DataFusion session without modifying underlying Delta files.
• ALTER TABLE REPLACE COLUMNSReplaces the entire column schema of a Delta table with a new set of columns in a single atomic operation.
• ALTER TABLE SET TBLPROPERTIESSets one or more table properties on an existing Delta table, used to enable features such as column...
• ALTER TABLE UNSET TBLPROPERTIESRemoves one or more table properties from an existing Delta table.
• CREATE DELTA TABLECreates a new Delta table with an explicit schema, optional partitioning, liquid clustering, table...
• CREATE VIEWCreates or replaces a named view backed by a SQL query.
• DROP DELTA TABLERemoves a Delta table from the session and catalog. Optionally deletes the underlying physical data files.
• DROP FEATURERemoves a Delta table feature (e.g., deletion vectors, change data feed, type widening) and optionally...
• DROP VIEWRemoves one or more views from the catalog and DataFusion session.

dml

• DELETEDeletes rows from a Delta table matching an optional predicate, recording file-level remove and add actions...
• INSERT INTOInserts new rows into a Delta table from a VALUES clause or SELECT query, with support for append...
• MERGE INTOPerforms an atomic upsert by combining INSERT, UPDATE, and DELETE actions in a single transaction, joining a...
• PARALLEL CREATE TABLE ASCreates a Delta table from a SELECT query by splitting the source on a numeric key column and running...
• PARALLEL INSERT INTOInserts SELECT results into an existing Delta table by splitting the source on a numeric key column and...
• TRUNCATE TABLERemoves all rows from a Delta table while preserving the table schema, properties, and transaction history.
• UPDATEUpdates column values in rows of a Delta table that match an optional predicate, rewriting affected data...

graph

• CREATE GRAPHCreates a named property graph definition that maps a vertex table and an edge table from the Delta...
• CREATE GRAPHCSRPre-builds and writes the Compressed Sparse Row (CSR) topology for a named graph to disk, enabling...
• CREATE GRAPHGPUPre-builds and persists Vulkan-derived GPU buffers (w_out, in_edge_weights) for a named graph as a compact...
• DROP GRAPHDrops a named graph definition from the catalog and session registries without deleting the underlying...
• DROP GRAPH CONFIGDrops per-table graph configuration entries from the session registry and catalog, removing the column...
• SHOW GRAPHDisplays the full configuration of one or all named graph definitions, including vertex/edge table mappings...

incremental

• GET INCREMENTAL FILTERQueries a target Delta table for maximum column values and generates a WHERE clause for incremental data...
• SET INCREMENTAL CONFIGPersists incremental loading configuration as Delta table properties for use by INCREMENTAL FILTER.
• SHOW INCREMENTAL CONFIGDisplays the stored incremental loading configuration for a Delta table.
• UNSET INCREMENTAL CONFIGRemoves all incremental loading configuration from a Delta table's properties.

indexing

• ALTER INDEXUpdates a row-level index's mutable properties such as the auto-update flag and algorithm-specific options.
• CREATE BLOOM FILTER INDEXCreates bloom filter indexes on specified columns for efficient file-level data skipping.
• CREATE INDEXCreates a row-level sorted index (PGM or B+ tree) over a Delta table to accelerate equality and range...
• DESCRIBE INDEXESLists all row-level indexes on a table along with their status, version binding, algorithm, leaf count, and...
• DROP BLOOM FILTER INDEXRemoves bloom filter indexes from a Delta table.
• DROP INDEXDrops a row-level index from a Delta table. The child index Delta table is tombstoned at the current version.
• REBUILD INDEXRebuilds a row-level index from scratch at the parent table's current version, replacing the stale index...

maintenance

• CLONECreates a copy of a Delta table, either as a lightweight metadata reference (shallow) or a full independent...
• CONVERT TO DELTAConverts an existing Parquet or Iceberg directory to Delta Lake format in place by writing a fresh...
• DESCRIBE AUTO OPTIMIZEShows the current auto-optimization configuration and status for a Delta table.
• DESCRIBE MAINTENANCE STATUSShows health metrics, circuit breaker state, and maintenance scheduler status for a table.
• GENERATE MANIFESTGenerates a symlink format manifest file listing all active data files in a Delta table for use by external...
• INCREMENTAL VACUUMPerforms resumable, batch-based vacuum for very large tables.
• OPTIMIZECompacts small files into larger files and optionally applies Z-ordering for improved read performance.
• REORG TABLEReorganizes table data by purging soft-deleted data, forcing a checkpoint, or upgrading for Iceberg...
• RESET CIRCUIT BREAKERManually resets the circuit breaker for a table's maintenance operations, re-enabling operations that were...
• RESTORE TO TIMESTAMPRestores a Delta table to the state it had at a specific point in time.
• RESTORE TO VERSIONRestores a Delta table to the state it had at a specific version number.
• SET AUTO OPTIMIZEEnables or disables automatic post-write compaction and optimized writes for a Delta table.
• VACUUMRemoves old, unreferenced data files from a Delta table to reclaim storage.
• VACUUM LITEPerforms a lightweight vacuum using only the transaction log, without scanning storage.
• ZORDERApplies Z-order data layout optimization to a Delta table for efficient multi-dimensional data skipping.

metastore

• ALTER METASTOREActs on an existing metastore mirror. Today the only supported action is REFRESH, which re-ingests the table...
• CREATE METASTOREMirrors a Delta table's `_delta_log/` action stream and full Parquet footer state into the Postgres-backed...
• DROP METASTOREDrops a table from the metastore: removes its registry row and every per-table partition (`parquet_file`...
• SHOW METASTORELists every Delta table currently registered with the metastore together with its hydration state...

pipeline

• DROP PIPELINERemoves a pipeline declaration from the current session's pipeline registry.
• DROP SCHEDULERemoves a schedule declaration from the current session's schedule registry.
• INCLUDE SCRIPTInlines a script's SQL at the current location for reuse across pipelines.
• PIPELINEDeclares a pipeline with metadata, scheduling, and governance attributes.
• SCHEDULEDeclares a named schedule with cron timing, retry policies, concurrency limits, and notification settings...
• SET $paramSets a script-scoped parameter. The expression is captured as raw SQL text and re-evaluated each time the...
• SHOW PIPELINESLists pipelines declared in the current session, optionally filtered by a LIKE pattern.
• SHOW SCHEDULESLists schedules declared in the current session, optionally filtered by a LIKE pattern.

pseudonymisation

• ALTER PSEUDONYMISATION RULEEnables or disables a pseudonymisation rule, or adds and removes principals from its exempt list.
• APPLY PSEUDONYMISATIONPermanently transforms existing data (destructive -- cannot be undone).
• CREATE PSEUDONYMISATION RULECreates a runtime data transformation rule for GDPR compliance.
• DROP PSEUDONYMISATION RULERemoves a pseudonymisation rule from a table.
• SHOW PSEUDONYMISATION RULESLists active pseudonymisation rules.

security

• ALTER GROUP ADD USERAdds one or more users to a group.
• ALTER GROUP REMOVE USERRemoves one or more users from a group.
• ALTER ROLEUpdates an existing role's parent or comment.
• ALTER USERUpdates an existing user's default role or comment.
• CREATE GROUPCreates a group for collective role assignment.
• CREATE ROLECreates a role that bundles privileges and can inherit from a parent role.
• CREATE SERVICE PRINCIPALCreates a service principal: a non-human identity for automation, jobs, integrations, and pipelines.
• CREATE USERCreates a user identity in the catalog. Authentication material is provisioned separately by the identity...
• CREATE WORKSPACECreates a workspace boundary for isolating user assets, scripts, and pipelines.
• DROP GROUPRemoves a group. The Control Plane cascades the removal: memberships are deleted and direct grants on the...
• DROP ROLERemoves a role. The Control Plane cascades the removal: role grants and direct object grants for this role...
• DROP SERVICE PRINCIPALRemoves a service principal. The Control Plane cascades the removal: role grants and direct object grants...
• DROP USERRemoves a user identity. The Control Plane cascades the removal: role grants and direct object grants...
• DROP WORKSPACERemoves a workspace. The Control Plane cascades the removal across the workspace's grants and metadata.
• GRANT ON EXTERNAL LOCATIONGrants one or more privileges on an external location to a principal. Supports WITH GRANT OPTION for...
• GRANT ON SCHEMAGrants a single privilege on a schema to a user or role.
• GRANT ON STORAGE CREDENTIALGrants one or more privileges on a storage credential to a principal. Supports WITH GRANT OPTION.
• GRANT ON TABLEGrants a single privilege on a table to a user or role.
• GRANT ON ZONEGrants a single privilege on a zone to a user or role.
• GRANT ROLEGrants a role to a user, group, or service principal. Idempotent: re-granting an existing assignment...
• REVOKE ON EXTERNAL LOCATIONRevokes one or more privileges on an external location from a principal.
• REVOKE ON SCHEMARevokes a single privilege on a schema from a user or role.
• REVOKE ON STORAGE CREDENTIALRevokes one or more privileges on a storage credential from a principal.
• REVOKE ON TABLERevokes a single privilege on a table from a user or role.
• REVOKE ON ZONERevokes a single privilege on a zone from a user or role.
• REVOKE ROLERevokes a role from a user, group, or service principal. Idempotent: revoking a non-existent assignment...
• SHOW GRANTS ON EXTERNAL LOCATIONLists every principal that holds a privilege on a given external location.
• SHOW GRANTS ON STORAGE CREDENTIALLists every principal that holds a privilege on a given storage credential.
• SHOW GRANTS TO PRINCIPALLists every grant assigned to a principal across object types: roles, zones, schemas, tables, external...
• SHOW GROUPSLists groups in the catalog, optionally filtered by a LIKE pattern.
• SHOW ROLESLists roles in the catalog, optionally filtered by a LIKE pattern.
• SHOW SERVICE PRINCIPALSLists service principals in the catalog, optionally filtered by a LIKE pattern.
• SHOW USERSLists users in the catalog, optionally filtered by a LIKE pattern.
• SHOW WORKSPACESLists workspaces in the catalog, optionally filtered by a LIKE pattern.

select-grammar

• Aggregate FunctionsFunctions that compute a single result from a set of rows.
• Common Table Expressions (WITH)Named temporary result sets that exist for the scope of a single query.
• GROUP BYGroups rows by column values for aggregate calculations.
• HAVINGFilters groups after aggregation (like WHERE for GROUP BY).
• JOIN TypesCombines rows from two or more tables based on a related column.
• LATERAL SubqueryA subquery in FROM that can reference columns from preceding tables.
• LIMIT / OFFSETPagination -- limits result count and skips rows.
• ORDER BYSorts the result set by one or more columns.
• SELECTRetrieves data from tables with filtering, grouping, and ordering.
• SubqueriesNested queries used in FROM, WHERE, or SELECT clauses.
• UNION / INTERSECT / EXCEPTCombines result sets from multiple queries.
• Window FunctionsCompute values across a set of rows related to the current row.

statistics

• ANALYZE TABLEComputes histogram statistics and optional bloom filters for table columns to improve query optimization.
• DESCRIBE STATISTICSDisplays computed histogram statistics metadata for a table, including histogram methods, bin counts, and...
• DROP STATISTICSRemoves computed histogram statistics for a Delta table.

system

• EXECPLANInspects a SQL query without executing it. Each EXECPLAN mode returns a single focused, CLI-friendly slice...
• FSCK REPAIR TABLEDetects and repairs metadata inconsistencies by removing transaction log entries that reference data files...
• HELPDisplays documentation for DeltaForge SQL commands, including command listings, descriptions, syntax...
• SHOW STATSRuns a SQL statement under instrumentation and returns a per-metric breakdown of what the planner intended...

table-info

• DESCRIBE CHECKPOINTLists transaction-log checkpoints for a Delta table, or returns detailed metadata for a single checkpoint...
• DESCRIBE DETAILReturns a comprehensive set of metadata properties for a Delta table, including format, location...
• DESCRIBE HISTORYReturns the version history of a Delta table, showing each commit's version number, timestamp, operation...
• DESCRIBE TABLEReturns the schema of a Delta table, listing each column's name, data type, nullability, partition status...
• SHOW TABLE PROPERTIESReturns the configuration properties (tblproperties) stored in a Delta table's metadata, displayed as...

utility

• COMPARE SCHEMACompares two schemas (from DDL strings or existing tables) and returns a detailed diff with generated ALTER...
• CREATE CHARTRenders an inline source query as an SVG chart and returns it in the execution result for the GUI to display.
• EXTRACT LINEAGEParses a SQL script and extracts table-level data lineage, returning inbound (read) and outbound (write)...
• INFERTYPEExecutes a query or scans a table, then runs the type inference engine on the result columns to detect...
• SCRIPT TABLE AS CREATEGenerates a complete CREATE DELTA TABLE DDL script from an existing table's metadata, including column...
• SQLFORMATFormats a SQL string according to a configurable style preset, with optional overrides for indentation...