Struct CreateTableBuilder 

pub struct CreateTableBuilder {

    pub or_replace: bool,
    pub temporary: bool,
    pub external: bool,
    pub global: Option<bool>,
    pub if_not_exists: bool,
    pub transient: bool,
    pub volatile: bool,
    pub iceberg: bool,
    pub snapshot: bool,
    pub dynamic: bool,
    pub name: ObjectName,
    pub columns: Vec<ColumnDef>,
    pub constraints: Vec<TableConstraint>,
    pub hive_distribution: HiveDistributionStyle,
    pub hive_formats: Option<HiveFormat>,
    pub file_format: Option<FileFormat>,
    pub location: Option<String>,
    pub query: Option<Box<Query>>,
    pub without_rowid: bool,
    pub like: Option<CreateTableLikeKind>,
    pub clone: Option<ObjectName>,
    pub version: Option<TableVersion>,
    pub comment: Option<CommentDef>,
    pub on_commit: Option<OnCommit>,
    pub on_cluster: Option<Ident>,
    pub primary_key: Option<Box<Expr>>,
    pub order_by: Option<OneOrManyWithParens<Expr>>,
    pub partition_by: Option<Box<Expr>>,
    pub cluster_by: Option<WrappedCollection<Vec<Expr>>>,
    pub clustered_by: Option<ClusteredBy>,
    pub inherits: Option<Vec<ObjectName>>,
    pub partition_of: Option<ObjectName>,
    pub for_values: Option<ForValues>,
    pub strict: bool,
    pub copy_grants: bool,
    pub enable_schema_evolution: Option<bool>,
    pub change_tracking: Option<bool>,
    pub data_retention_time_in_days: Option<u64>,
    pub max_data_extension_time_in_days: Option<u64>,
    pub default_ddl_collation: Option<String>,
    pub with_aggregation_policy: Option<ObjectName>,
    pub with_row_access_policy: Option<RowAccessPolicy>,
    pub with_storage_lifecycle_policy: Option<StorageLifecyclePolicy>,
    pub with_tags: Option<Vec<Tag>>,
    pub base_location: Option<String>,
    pub external_volume: Option<String>,
    pub with_connection: Option<ObjectName>,
    pub catalog: Option<String>,
    pub catalog_sync: Option<String>,
    pub storage_serialization_policy: Option<StorageSerializationPolicy>,
    pub table_options: CreateTableOptions,
    pub target_lag: Option<String>,
    pub warehouse: Option<Ident>,
    pub refresh_mode: Option<RefreshModeKind>,
    pub initialize: Option<InitializeKind>,
    pub require_user: bool,
    pub diststyle: Option<DistStyle>,
    pub distkey: Option<Expr>,
    pub sortkey: Option<Vec<Expr>>,
    pub backup: Option<bool>,
    pub multiset: Option<bool>,
    pub fallback: Option<bool>,
    pub with_data: Option<WithData>,
}

Builder for create table statement variant (1).

This structure helps building and accessing a create table with more ease, without needing to:

• Match the enum itself a lot of times; or
• Moving a lot of variables around the code.

Example

use sqlparser::ast::helpers::stmt_create_table::CreateTableBuilder;
use sqlparser::ast::{ColumnDef, DataType, Ident, ObjectName};
let builder = CreateTableBuilder::new(ObjectName::from(vec![Ident::new("table_name")]))
   .if_not_exists(true)
   .columns(vec![ColumnDef {
       name: Ident::new("c1"),
       data_type: DataType::Int(None),
       options: vec![],
}]);
// You can access internal elements with ease
assert!(builder.if_not_exists);
// Convert to a statement
assert_eq!(
   builder.build().to_string(),
   "CREATE TABLE IF NOT EXISTS table_name (c1 INT)"
)

Fields

or_replace: bool

Whether the statement uses OR REPLACE.

temporary: bool

Whether the table is TEMPORARY.

external: bool

Whether the table is EXTERNAL.

global: Option<bool>

Optional GLOBAL flag for dialects that support it.

if_not_exists: bool

Whether IF NOT EXISTS was specified.

transient: bool

Whether TRANSIENT was specified.

volatile: bool

Whether VOLATILE was specified.

iceberg: bool

Iceberg-specific table flag.

snapshot: bool

SNAPSHOT table flag.

dynamic: bool

Whether DYNAMIC table option is set.

name: ObjectName

The table name.

columns: Vec<ColumnDef>

Column definitions for the table.

constraints: Vec<TableConstraint>

Table-level constraints.

hive_distribution: HiveDistributionStyle

Hive distribution style.

hive_formats: Option<HiveFormat>

Optional Hive format settings.

file_format: Option<FileFormat>

Optional file format for storage.

location: Option<String>

Optional storage location.

query: Option<Box<Query>>

Optional AS SELECT query for the table.

without_rowid: bool

Whether WITHOUT ROWID is set.

like: Option<CreateTableLikeKind>

Optional LIKE clause kind.

clone: Option<ObjectName>

Optional CLONE source object name.

version: Option<TableVersion>

Optional table version.

comment: Option<CommentDef>

Optional table comment.

on_commit: Option<OnCommit>

Optional ON COMMIT behavior.

on_cluster: Option<Ident>

Optional cluster identifier.

primary_key: Option<Box<Expr>>

Optional primary key expression.

order_by: Option<OneOrManyWithParens<Expr>>

Optional ORDER BY for clustering/sorting.

partition_by: Option<Box<Expr>>

Optional PARTITION BY expression.

cluster_by: Option<WrappedCollection<Vec<Expr>>>

Optional CLUSTER BY expressions.

clustered_by: Option<ClusteredBy>

Optional CLUSTERED BY clause.

inherits: Option<Vec<ObjectName>>

Optional parent tables (INHERITS).

partition_of: Option<ObjectName>

Optional partitioned table (PARTITION OF)

for_values: Option<ForValues>

Range of values associated with the partition (FOR VALUES)

strict: bool

STRICT table flag.

copy_grants: bool

Whether to copy grants from the source.

enable_schema_evolution: Option<bool>

Optional flag for schema evolution support.

change_tracking: Option<bool>

Optional change tracking flag.

data_retention_time_in_days: Option<u64>

Optional data retention time in days.

max_data_extension_time_in_days: Option<u64>

Optional max data extension time in days.

default_ddl_collation: Option<String>

Optional default DDL collation.

with_aggregation_policy: Option<ObjectName>

Optional aggregation policy object name.

with_row_access_policy: Option<RowAccessPolicy>

Optional row access policy applied to the table.

with_storage_lifecycle_policy: Option<StorageLifecyclePolicy>

Optional storage lifecycle policy applied to the table.

with_tags: Option<Vec<Tag>>

Optional tags/labels attached to the table metadata.

base_location: Option<String>

Optional base location for staged data.

external_volume: Option<String>

Optional external volume identifier.

with_connection: Option<ObjectName>

WITH CONNECTION clause. BigQuery

catalog: Option<String>

Optional catalog name.

catalog_sync: Option<String>

Optional catalog synchronization option.

storage_serialization_policy: Option<StorageSerializationPolicy>

Optional storage serialization policy.

table_options: CreateTableOptions

Parsed table options from the statement.

target_lag: Option<String>

Optional target lag configuration.

warehouse: Option<Ident>

Optional warehouse identifier.

refresh_mode: Option<RefreshModeKind>

Optional refresh mode for materialized tables.

initialize: Option<InitializeKind>

Optional initialization kind for the table.

require_user: bool

Whether operations require a user identity.

diststyle: Option<DistStyle>

Redshift DISTSTYLE option.

distkey: Option<Expr>

Redshift DISTKEY option.

sortkey: Option<Vec<Expr>>

Redshift SORTKEY option.

backup: Option<bool>

Redshift BACKUP option.

multiset: Option<bool>

MULTISET | SET table-kind prefix.

fallback: Option<bool>

FALLBACK clause.

with_data: Option<WithData>

WITH DATA clause.

Implementations

impl CreateTableBuilder

pub fn new(name: ObjectName) -> Self

Create a new CreateTableBuilder for the given table name.

pub fn or_replace(self, or_replace: bool) -> Self

Set OR REPLACE for the CREATE TABLE statement.

pub fn temporary(self, temporary: bool) -> Self

Mark the table as TEMPORARY.

pub fn external(self, external: bool) -> Self

Mark the table as EXTERNAL.

pub fn global(self, global: Option<bool>) -> Self

Set optional GLOBAL flag (dialect-specific).

pub fn if_not_exists(self, if_not_exists: bool) -> Self

Set IF NOT EXISTS.

pub fn transient(self, transient: bool) -> Self

Set TRANSIENT flag.

pub fn volatile(self, volatile: bool) -> Self

Set VOLATILE flag.

pub fn iceberg(self, iceberg: bool) -> Self

Enable Iceberg table semantics.

pub fn snapshot(self, snapshot: bool) -> Self

Set SNAPSHOT table flag (BigQuery).

pub fn dynamic(self, dynamic: bool) -> Self

Set DYNAMIC table option.

pub fn columns(self, columns: Vec<ColumnDef>) -> Self

Set the table column definitions.

pub fn constraints(self, constraints: Vec<TableConstraint>) -> Self

Set table-level constraints.

pub fn hive_distribution(self, hive_distribution: HiveDistributionStyle) -> Self

Set Hive distribution style.

pub fn hive_formats(self, hive_formats: Option<HiveFormat>) -> Self

Set Hive-specific formats.

pub fn file_format(self, file_format: Option<FileFormat>) -> Self

Set file format for the table (e.g., PARQUET).

pub fn location(self, location: Option<String>) -> Self

Set storage location for the table.

pub fn query(self, query: Option<Box<Query>>) -> Self

Set an underlying AS SELECT query for the table.

pub fn without_rowid(self, without_rowid: bool) -> Self

Set WITHOUT ROWID option.

pub fn like(self, like: Option<CreateTableLikeKind>) -> Self

Set LIKE clause for the table.

pub fn clone_clause(self, clone: Option<ObjectName>) -> Self

Set CLONE source object name.

pub fn version(self, version: Option<TableVersion>) -> Self

Set table VERSION.

pub fn comment_after_column_def(self, comment: Option<CommentDef>) -> Self

Set a comment for the table or following column definitions.

pub fn on_commit(self, on_commit: Option<OnCommit>) -> Self

Set ON COMMIT behavior for temporary tables.

pub fn on_cluster(self, on_cluster: Option<Ident>) -> Self

Set cluster identifier for the table.

pub fn primary_key(self, primary_key: Option<Box<Expr>>) -> Self

Set a primary key expression for the table.

pub fn order_by(self, order_by: Option<OneOrManyWithParens<Expr>>) -> Self

Set ORDER BY clause for clustered/sorted tables.

pub fn partition_by(self, partition_by: Option<Box<Expr>>) -> Self

Set PARTITION BY expression.

pub fn cluster_by( self, cluster_by: Option<WrappedCollection<Vec<Expr>>>, ) -> Self

Set CLUSTER BY expression(s).

pub fn clustered_by(self, clustered_by: Option<ClusteredBy>) -> Self

Set CLUSTERED BY clause.

pub fn inherits(self, inherits: Option<Vec<ObjectName>>) -> Self

Set parent tables via INHERITS.

pub fn partition_of(self, partition_of: Option<ObjectName>) -> Self

Sets the table which is partitioned to create the current table.

pub fn for_values(self, for_values: Option<ForValues>) -> Self

Sets the range of values associated with the partition.

pub fn strict(self, strict: bool) -> Self

Set STRICT option.

pub fn copy_grants(self, copy_grants: bool) -> Self

Enable copying grants from source object.

pub fn enable_schema_evolution( self, enable_schema_evolution: Option<bool>, ) -> Self

Enable or disable schema evolution features.

pub fn change_tracking(self, change_tracking: Option<bool>) -> Self

Enable or disable change tracking.

pub fn data_retention_time_in_days( self, data_retention_time_in_days: Option<u64>, ) -> Self

Set data retention time (in days).

pub fn max_data_extension_time_in_days( self, max_data_extension_time_in_days: Option<u64>, ) -> Self

Set maximum data extension time (in days).

pub fn default_ddl_collation( self, default_ddl_collation: Option<String>, ) -> Self

Set default DDL collation.

pub fn with_aggregation_policy( self, with_aggregation_policy: Option<ObjectName>, ) -> Self

Set aggregation policy object.

pub fn with_row_access_policy( self, with_row_access_policy: Option<RowAccessPolicy>, ) -> Self

Attach a row access policy to the table.

pub fn with_storage_lifecycle_policy( self, with_storage_lifecycle_policy: Option<StorageLifecyclePolicy>, ) -> Self

Attach a storage lifecycle policy to the table.

pub fn with_tags(self, with_tags: Option<Vec<Tag>>) -> Self

Attach tags/labels to the table metadata.

pub fn base_location(self, base_location: Option<String>) -> Self

Set a base storage location for staged data.

pub fn external_volume(self, external_volume: Option<String>) -> Self

Set an external volume identifier.

pub fn with_connection(self, with_connection: Option<ObjectName>) -> Self

Set the WITH CONNECTION clause.

pub fn catalog(self, catalog: Option<String>) -> Self

Set the catalog name for the table.

pub fn catalog_sync(self, catalog_sync: Option<String>) -> Self

Set catalog synchronization option.

pub fn storage_serialization_policy( self, storage_serialization_policy: Option<StorageSerializationPolicy>, ) -> Self

Set a storage serialization policy.

pub fn table_options(self, table_options: CreateTableOptions) -> Self

Set arbitrary table options parsed from the statement.

pub fn target_lag(self, target_lag: Option<String>) -> Self

Set a target lag configuration (dialect-specific).

pub fn warehouse(self, warehouse: Option<Ident>) -> Self

Associate the table with a warehouse identifier.

pub fn refresh_mode(self, refresh_mode: Option<RefreshModeKind>) -> Self

Set refresh mode for materialized/managed tables.

pub fn initialize(self, initialize: Option<InitializeKind>) -> Self

Set initialization mode for the table.

pub fn require_user(self, require_user: bool) -> Self

Require a user identity for table operations.

pub fn diststyle(self, diststyle: Option<DistStyle>) -> Self

Set Redshift DISTSTYLE option.

pub fn distkey(self, distkey: Option<Expr>) -> Self

Set Redshift DISTKEY option.

pub fn sortkey(self, sortkey: Option<Vec<Expr>>) -> Self

Set Redshift SORTKEY option.

pub fn backup(self, backup: Option<bool>) -> Self

Set the Redshift BACKUP option.

pub fn multiset(self, multiset: Option<bool>) -> Self

Set MULTISET | SET table-kind prefix. Some(true) => MULTISET, Some(false) => SET.

pub fn fallback(self, fallback: Option<bool>) -> Self

Set FALLBACK / NO FALLBACK flag.

pub fn with_data(self, with_data: Option<WithData>) -> Self

Set WITH DATA clause.

pub fn build(self) -> CreateTable

Consume the builder and produce a CreateTable.

Trait Implementations

impl Clone for CreateTableBuilder

fn clone(&self) -> CreateTableBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateTableBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateTableBuilder

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CreateTableBuilder

impl From<CreateTable> for CreateTableBuilder

fn from(table: CreateTable) -> Self

Converts to this type from the input type.

impl Hash for CreateTableBuilder

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CreateTableBuilder

fn eq(&self, other: &CreateTableBuilder) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for CreateTableBuilder

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreateTableBuilder

impl TryFrom<Statement> for CreateTableBuilder

type Error = ParserError

The type returned in the event of a conversion error.

fn try_from(stmt: Statement) -> Result<Self, Self::Error>

Performs the conversion.

impl Visit for CreateTableBuilder

fn visit<V: Visitor>(&self, visitor: &mut V) -> ControlFlow<V::Break>

Visit this node with the provided Visitor.

impl VisitMut for CreateTableBuilder

fn visit<V: VisitorMut>(&mut self, visitor: &mut V) -> ControlFlow<V::Break>

Mutably visit this node with the provided VisitorMut.