GET DDL¶

The GET DDL function retrieves the Data Definition Language (DDL) statement used to create a table. It may include additional information that was added by BLUE (e.g., explicit NULL constraints).

Syntax¶

SELECT
  GET_DDL(["<schema_name>".]"<table_name>")

Parameters¶

Parameter	Parameter Type	Description
`schema_name`	Identifier	The name of the schema.
`table_name`	Identifier	The name of the table.

Examples¶

-- Create a table:
CREATE TABLE
  cool_animals (
    id INT NOT NULL,
    name TEXT NOT NULL,
    weight FLOAT,
    is_agressive BOOL DEFAULT false NOT NULL
  );

-- Get table ddl:
SELECT
  GET_DDL("cool_animals");

-- Result:
create table
  "public"."cool_animals" (
    "id" INT NOT NULL,
    "name" TEXT NOT NULL,
    "weight" DOUBLE NULL,
    "is_agressive" BOOL DEFAULT FALSE NOT NULL
  );

Exporting table DDL to a file¶

COPY
  (
    SELECT
      GET_DDL("cool_animals")
  ) TO
WRAPPER
  csv_fdw
OPTIONS
  (LOCATION = 's3://sqream-docs/cool_animals_ddl.csv');

Permissions¶

The role must have the CONNECT permission at the database level.