Snowflake
Quest Data Modeler (QDM) supports Snowflake as a target database. The following sections list the supported data types, database objects, and reverse and forward engineering parameters.
Supported Data Types
|
Numeric |
Logical |
String and Binary |
Date and Time |
Semi-Structured |
|
|---|---|---|---|---|---|
|
|
|
|
|
|
Supported Objects
The following objects are supported in Snowflake:
Note: You can use the Ctrl+Z and Ctrl+Y keyboard shortcuts to undo and redo changes in any property field.
Annotations
| Tab | Section | Property | Description | Additional Information |
|---|---|---|---|---|
| Properties | Name | Specifies the name of the annotation | ||
| Type | Specifies the type of the annotation | |||
| Physical Only | Indicates whether the annotation applies only to the physical model | |||
| Text Editor | Specifies the text in an annotation | Use this to add or edit text in an annotation. | ||
| Definition | Specifies the annotation description or business meaning | Use |
Database Roles
| Tab | Section | Property | Description |
|---|---|---|---|
| Properties | Name | Specifies the database role name | |
| Use Replace Syntax | Indicates whether an existing database role is replaced | ||
| If Not Exists | Indicates whether creation occurs only if the role does not exist | ||
| Do Not Generate | Indicates whether the role is excluded from generation | ||
| Tags List | Name | Specifies the tag name | |
| Value | Specifies the tag value |
Databases
| Tab | Section | Property | Description | Additional Information |
|---|---|---|---|---|
| Properties | Name | Specifies the database name | ||
| Use Replace Syntax | Indicates whether an existing database is replaced | |||
| If Not Exists | Indicates whether creation occurs only if the database does not exist | |||
| Generate | Specifies whether a SQL statement for the database is generated during forward engineering | |||
| Database Type | Specifies the database type |
Standard: Specifies a regular database with full features Shared: Specifies a database created from shared data Secondary: Specifies a replicated database |
||
| Transient | Indicates whether the database is transient. | |||
| Data Retention Time (In Days) | Specifies retention days for Time Travel operations | |||
| DEFAULT_DDL_COLLATION | Specifies the default collation for tables in the database | You can override the default collation at the individual table level. | ||
| Clone Of | Clone Database | Specifies the source database for clone creation | ||
| At or Before | Specifies the cloning point mode |
At: Specifies cloning at an exact point in time Before: Specifies cloning to a state before a given point |
||
| Time Type | Specifies the Time Travel reference type |
Timestamp: Specifies an exact date and time Offset: Specifies the difference from the current time, in seconds Statement: Specifies the query ID of a statement used as the reference point |
||
| Point | Specifies the clone reference point | |||
| From a Share | Clone From Share | Specifies clone creation from a shared source | ||
| Database Replication | As Replica Of | Specifies the identifier for a primary database from which to create a replica | ||
| Auto Refresh | Indicates whether replica refresh occurs automatically |
True: Specifies that replication is automatically refreshed. False: Specifies that replication is not automatically refreshed |
||
| Tags List | Name | Specifies the tag name | ||
| Value | Specifies the tag value |
Datatype Standards
| Tab | Section | Property | Description | Additional Information |
|---|---|---|---|---|
| Properties | Name | Specifies the name of the datatype standard | ||
| Is Active | Indicates whether the datatype standard is enabled for use | |||
| Logical Definition | Datatype | Specifies the logical datatype definition | ||
|
Domain |
Specifies the domain associated with the datatype | |||
| Length | Specifies the length of the datatype | |||
| Precision | Specifies the precision of numeric datatypes | |||
| Default Length | Specifies the default length for the datatype | |||
| Mapping | Name | Specifies the name of the datatype mapping | ||
| From | Specifies the source datatype | |||
| To | Specifies the target datatype | |||
| Definition | Specifies the detailed description or business meaning of the datatype standard | Use |
Default Values
| Tab | Section | Property | Description |
|---|---|---|---|
| Snowflake | Name | Specifies the name of the default value | |
| Physical Name | Specifies the physical name used in the database | ||
| Value | Specifies the default value assigned to the object | ||
| Logical Only | Indicates whether the default value applies only to the logical model | ||
| Physical Only | Indicates whether the default value applies only to the physical model |
Domains
| Tab | Section | Property | Description | Additional Information |
|---|---|---|---|---|
| Properties | Domain Parent | Specifies the parent domain from which the current domain inherits its properties | ||
| Name | Specifies the name of the domain | |||
| Physical Name | Specifies the physical name used in the database | |||
| Harden Strategy | Specifies how inherited properties from the parent domain are applied |
Inherit: Specifies that properties are inherited from the parent domain Override: Specifies that inherited properties can be modified. Harden: Specifies that inherited properties are fixed and cannot be changed |
||
| Physical Data Type | Specifies the physical datatype assigned to the domain | |||
| Null Option | Indicates whether null values are allowed for the domain |
Null: Specifies that null values are allowed Not Null: Specifies that null values are not allowed Case: Specifies case sensitivity behavior for the domain Identity: Indicates whether the domain uses an identity (auto-increment) property |
||
| Physical Only | Indicates whether the domain applies only to the physical model | |||
| Constraint | Check Constraints | Use Inherited Constraint | Specifies whether the validation rule is inherited from the parent domain | |
| Name | Specifies the name of the inherited validation rule to be attached to the selected domain | |||
| Validation | Specifies the validation rule to attach to the selected domain | |||
| Default | Use Inherited Default Value | Specifies whether the property is inherited from the parent domain | ||
| Name | Specifies the name of the default value to be attached to the selected domain | |||
| Default | Specifies the default value to attach to the selected domain | |||
| Definition | Specifies the detailed description or business meaning of the domain | Use |
ER Diagrams
| Tab | Section | Property | Description | Additional Information |
|---|---|---|---|---|
| Properties | Name | Specifies the name of the ER diagram | ||
| Logical Physical View Mode | Specifies whether the diagram is displayed in logical or physical view |
Logical: Specifies display of logical model elements Physical: Specifies display of physical database elements |
||
| Auto-populate | Indicates whether objects are automatically added to the diagram | |||
| General | General Options | Author | Specifies the author of the diagram | |
| Optional Theme | Theme | Specifies the theme applied to the diagram |
Classic Theme: Specifies standard visual styling DARK Theme: Specifies dark theme styling Default Theme: Specifies system default theme |
|
| Optional override to theme background fill | Fill Options | Specifies background fill settings for the diagram | ||
| Members | Available Objects | Name | Specifies the name of the available object | |
| Type | Indicates the type of the object | |||
| Included Objects | Name | Specifies the name of the included object in the diagram | ||
| Type | Indicates the type of the included object | |||
| Relationships | Available Relationships | Name | Specifies the name of the relationship | |
| Type | Indicates the type of the relationship | |||
| Parent | Specifies the parent object in the relationship | |||
| Child | Specifies the child object in the relationship | |||
| Included Relationships | Name | Specifies the name of the included relationship | ||
| Type | Indicates the type of the relationship | |||
| Parent | Specifies the parent object in the relationship | |||
| Child | Specifies the child object in the relationship | |||
| Layout | Manual Layout | Allow Manual Relationship Layout | Indicates whether relationship lines can be manually arranged | |
| Allow Manual Entity Resizing | Indicates whether entities can be resized manually | |||
| Grid Alignment | Align Objects to Grid | Indicates whether objects snap to the grid | ||
| Alignment Grid Spacing | Specifies the spacing between grid lines | |||
| Align Grid Color | Specifies the color of the alignment grid | |||
| Visual Cues | Show Page Grid | Indicates whether the page grid is displayed in the diagram | ||
| Show Background | Indicates whether the diagram background is displayed | |||
| Show Callout | Indicates whether callouts are displayed | |||
| Selection Grips Color | Specifies the color of selection handles | |||
| Display | Shadow | Display Shadows | Indicates whether shadows are applied to objects | |
| Shadow Offset - Right | Specifies the horizontal shadow offset | |||
| Shadow Offset - Bottom | Specifies the vertical shadow offset | |||
| Display Length | Definition and Comment Display Length | Specifies the maximum length of definitions and comments displayed | ||
| View Expression Display Length | Specifies the maximum length of expressions displayed | |||
| Relationship Display | Relationship Line Orientation | Specifies how relationship lines are displayed | ||
| Display Dangling Relationships | Indicates whether incomplete relationships are displayed | |||
| Split Verb Phrase | Indicates whether verb phrases are split across relationship directions | |||
| Display Child-To-Parent Verb Phrase | Indicates whether child-to-parent relationship text is displayed | |||
| Display Parent-To-Child Verb Phrase | Indicates whether parent-to-child relationship text is displayed | |||
| Display Subcategory Cardinality | Indicates whether subtype cardinality is displayed | |||
| Preferences | Display Lines on top | Indicates whether lines are drawn above diagram objects | ||
| Entity | Display Level | Logical Display Level | Specifies the level of detail displayed for entities | |
| Entity Display Options | Show Attributes/Columns as Grid | Indicates whether attributes are displayed in grid format | ||
| Display Rolenames | Indicates whether role names are displayed | |||
| Display Attribute Data Type | Indicates whether attribute data types are displayed | |||
| Display Attribute Domain | Indicates whether domains are displayed | |||
| Display Attribute Null Option | Indicates whether nullability is displayed | |||
| Display Attribute SDI Option | Indicates whether SDI information is displayed | |||
| Display Physical Name | Indicates whether physical names are shown | |||
| Display Logical Primary Key (PK) Designator | Indicates whether key designators are displayed | |||
| Display Logical Foreign Key (FK) Designator | ||||
| Display Logical Alternate Key (AK) Designator | ||||
| Display Migrated Attributes | Indicates whether migrated attributes are displayed | |||
| Display Attribute Icon | Indicates whether icons are displayed | |||
| Display Entity Icon | ||||
| Table | Display Level | Physical Display Level | Specifies the level of detail displayed for tables | |
| Table Display Options | Show Attributes/Columns as Grid | Indicates whether columns are displayed in grid format | ||
| Display Column Data Type | Indicates whether column properties are displayed | |||
| Display Column Domain | Indicates whether column domains are displayed | |||
| Display Column Null Option | Indicates whether column nullability is displayed. | |||
| Display Column SDI Option | Indicates whether SDI information is displayed | |||
| Display Logical Name | Indicates whether logical names are displayed | |||
| Display Physical Primary Key (PK) Designator | Indicates whether key designators are displayed | |||
| Display Physical Foreign Key (FK) Designator | ||||
| Display Physical Alternate Key (AK) Designator | ||||
| Display Owner | Indicates whether ownership details are displayed | |||
| Display Owner For Non Current Users | Indicates whether ownership is displayed for non-current users | |||
| Display Ungenerated Tables | Indicates whether ungenerated objects are displayed | |||
| Display Ungenerated Indexes | Indicates whether ungenerated indexes are displayed | |||
| View | View Display Options | Display Views | Indicates whether views are displayed | |
| Display View Simple Mode | Indicates whether simplified view mode is used | |||
| Display View Relationships | Indicates whether view relationships are displayed | |||
| Display View Column Expression | Indicates whether view column properties are displayed | |||
| Display View Column Data Type | Indicates whether view column data types are displayed | |||
| Display View Column Null Option | Indicates whether view column nullability is displayed | |||
| Display Ungenerated Views | Indicates whether ungenerated views are displayed | |||
| Relationship | Relationship Display Options | Display Relationships | Indicates whether relationships are displayed | |
| Relationship Logical Display Options | Display Logical Relationship Name | Indicates whether relationship names are displayed | ||
| Display Logical Cardinality | Indicates whether cardinality is displayed | |||
| Display Logical Referential Integrity | Indicates whether integrity constraints are shown | |||
| Display Subtype Discriminator | Indicates whether subtype discriminator is shown | |||
| Relationship Physical Display Options | Display Physical Relationship Name | Indicates whether relationship names are displayed | ||
| Display Physical Cardinality | Indicates whether cardinality is displayed | |||
| Display Physical Referential Integrity | Indicates whether integrity constraints are shown | |||
| Display Ungenerated Relationships | Indicates whether ungenerated relationships are displayed | |||
| Page Setup | Page Size | Paper Size | Specifies the paper size | |
| Print Orientation | Specifies the orientation of the printed diagram |
Portrait: Specifies vertical orientation Landscape: Specifies horizontal orientation |
||
| Print Scaling | Specifies scaling applied during printing | |||
| Miscellaneous | Print Border | Indicates whether borders are printed | ||
| Print In Color | Indicates whether the diagram is printed in color | |||
| Page Setup Margins | Margins (inches) | Footer | Specifies margin values for printing | |
| Header | ||||
| Margins (inches) | Top Margin | |||
| Header Margin | ||||
| Left Margin | ||||
| Right Margin | ||||
| Footer Margin | ||||
| Bottom Margin | ||||
| Definition | Specifies the detailed description or purpose of the diagram | Use |
File Formats
| Tab | Section | Property | Description | Additional Information |
|---|---|---|---|---|
| Properties | Name | Specifies the name of the file format | ||
| Schema | Specifies the schema that contains the file format | |||
| Use Replace Syntax | Indicates whether the file format should be replaced if it already exists | |||
| If Not Exists | Indicates whether the file format is created only if it does not already exist | |||
| Generate | Indicates whether the file format is included in script generation | |||
| Stage Format Options | Stage File Format Type | Specifies the format of input or output files used for data loading or unloading |
Based on the selected file format type, additional format-specific properties are enabled. CSV – Specifies comma-separated values format for structured data JSON – Specifies JavaScript Object Notation format for semi-structured data AVRO – Specifies Avro format for schema-based binary data ORC – Specifies optimized columnar format for large-scale data processing PARQUET – Specifies columnar storage format for high-performance analytics XML – Specifies extensible markup language format for hierarchical data None – Specifies that no file format is selected |
|
| File Format Options | Specifies the format-specific options available for the selected file format type |
Functions
| Tab | Section | Property | Description | Additional Information |
|---|---|---|---|---|
| Properties | Name | Specifies the function name | ||
| Schema | Specifies the schema for the function | |||
| Use Replace Syntax | Indicates whether the function should be replaced if it already exists | |||
| Generate | Indicates whether the function is included in generation | |||
| Secure | Indicates whether the function is secure | |||
| Is Not Null | Indicates non-null return behavior |
Null: Allows null return values Not Null: Does not allow null return values |
||
| Language Type | Specifies the programming language used for the function | Javascript: Specifies JavaScript-based function implementation | ||
| Return Type Options | Specifies function return type options |
Result data Type: Specifies a scalar return value Table Ref: Specifies a table-return function |
||
| Call Return Type | Specifies how the function behaves when handling null inputs |
Called On Null Input: Executes even when input is null Returns Null On Null Input: Returns null if input is null Strict: Does not execute when input is null |
||
| Volatile Or Immutable | Specifies whether the function output changes based on input |
Volatile: Output may change for the same input Immutable: Output is consistent for the same input |
||
| As Function Definition | Specifies the function definition used to compute and return the result | |||
| Function Type | Function Type | Specifies the type of function | Scalar Function: Returns a single value | |
| Parameter Options | Name | Specifies the name of the parameter | ||
| Physical Data Type | Specifies the datatype of the parameter | |||
| Default Value | Specifies the default value assigned to the parameter | |||
| Code | Specifies the function logic or implementation code | Use |
||
| Expanded | Displays the SQL definition of the function |
Provides a built-in editor to view and manage the SQL definition. The following options are available: Fold All / Unfold All – Specifies options to collapse or expand the SQL content Go to Line – Specifies navigation to a specific line in the script Validate – Specifies validation of the SQL syntax Read Only – Indicates whether the SQL editor is in read-only mode SQL – Indicates whether editing mode is enabled |
Materialized Views
| Tab | Section | Property | Description | Additional Information |
|---|---|---|---|---|
| Properties | Properties | Name | Specifies the name of the materialized view | |
| Comments | Specifies additional descriptive information for the materialized view | |||
| Copy Grants | Indicates whether existing access privileges are copied to the materialized view | |||
| Cluster By Expression | Specifies the expression used to cluster the materialized view | |||
| Generate | Indicates whether the materialized view is included in script generation | |||
| Schema | Specifies the schema in which the materialized view is created | |||
| Database | Specifies the database in which the materialized view is created | |||
| CTAS Type | Specifies the type of CREATE operation used to define the materialized view |
Create Table As Select: Specifies creation using a SELECT query Create Hybrid Table As Select: Specifies creation as a hybrid table Create Iceberg Table As Select: Specifies creation as an Iceberg table |
||
| Use Replace Syntax | Indicates whether the materialized view should be replaced if it already exists | |||
| If Not Exists | Indicates whether the materialized view is created only if it does not already exist | |||
| Iceberg Table As Select Options | External Volume | Specifies the external storage volume used for the Iceberg table | ||
| Catalog | Specifies the catalog used for the Iceberg table | Snowflake: Specifies Snowflake-managed catalog | ||
| Base Location | Specifies the base storage location for the Iceberg table | |||
| Additional Options | Row Access Policy | Specifies the row-level access policy applied to the materialized view | ||
| Row Access Policy Columns | Column | Specifies the columns used to enforce the row access policy | ||
| Selected | Specifies the columns selected for the materialized view | |||
| Select | Available Tables and Views | Name | Specifies the name of the available table or view | |
| Type | Indicates the type of the source object | |||
| Columns | Name | Specifies the column selected for the query | ||
| Alias | Specifies the alias assigned to the column | |||
| Value | Specifies the expression or value assigned to the column | |||
| From | Available Tables and Views | Name | Specifies the name of the available table or view | |
| Type | Indicates the type of the source object (for example, table or view) | |||
| FROM | Name | Specifies the source table or view used in the query | ||
| Alias | Specifies the alias assigned to the source object | |||
| Type | Indicates the type of the source object | |||
| Where | Where Clause | Where | Specifies the filtering condition applied to the data | |
| Group By Clause | Group By | Specifies the columns used to group the result set | ||
| Having Clause | Having | Specifies the condition applied to grouped data | ||
| Qualify Clause | Qualify | Specifies filtering conditions applied after window functions | ||
| Order By Clause | Order | Specifies the sorting order of the result set | ||
| Tags List | Name | Specifies the tag name assigned to the materialized view | ||
| Value | Specifies the value associated with the ta | |||
| User Defined Sql | User Defined SQL Statement | Specifies a custom SQL statement used to define the materialized view |
Provides a built-in SQL editor to create and manage custom SQL statements with the following options:
|
|
| Sql | Displays the SQL definition of the materialized view |
Provides a built-in editor to view and manage the SQL definition. The following options are available: Fold All / Unfold All – Specifies options to collapse or expand the SQL content Go to Line – Specifies navigation to a specific line in the script Validate – Specifies validation of the SQL syntax Read Only – Indicates whether the SQL editor is in read-only mode SQL – Indicates whether editing mode is enabled |
||
| Style | Comments Display | Font Options | Specifies font settings for comments | |
| Fill Options | Specifies background styling for the object | |||
| Outline Options | Specifies border and outline styling | |||
| Column Display Fonts | Owned Column | Specifies font styling for owned columns | ||
| Alternate Key (AK) Column | Specifies font styling for alternate key columns | |||
| Inversion Entry (IE) | Specifies font styling for inversion entry columns | |||
| Expression | Specifies font styling for column expressions |
Naming Standards
| Tab | Section | Property | Description | Additional Information |
|---|---|---|---|---|
| Logical | Entity | Specifies the naming standard format for logical entity names |
Specifies how name components are constructed using predefined parts. Prime – Specifies the core noun or primary business term Modifier 1 (M1) – Specifies the first qualifier describing the prime Modifier 2 (M2) – Specifies the second qualifier providing additional context Class (C) – Specifies the type or classification of the object
|
|
| Attribute | Specifies the naming standard format for logical attribute names | |||
| Domain | Specifies the naming standard format for logical domain names | |||
| Physical | Table | Specifies the naming standard format for physical table names | ||
| Column | Specifies the naming standard format for physical column names | |||
| Domain | Specifies the naming standard format for physical domain names | |||
| Glossary | Word/Words | Specifies the business terms used to define naming standards | ||
| Abbreviation | Specifies the standardized abbreviation for a word | |||
| Alt Abbreviation | Specifies an alternate abbreviation for the word | |||
| P, M, M1, M2, C | Indicates the role of the word in the naming structure |
|
||
| Definition | Specifies the description or meaning of the glossary word | |||
| Definition | Specifies the detailed description or purpose of the naming standard | Use |
Relationships
| Tab | Section | Property | Description | Additional Information |
|---|---|---|---|---|
| Properties | Name | Specifies the name of the relationship | ||
| Physical Name | Specifies the physical name used in the database | |||
| Harden Strategy | Specifies how inherited relationship properties are applied |
Inherit: Specifies that properties are inherited from the parent Override: Specifies that inherited properties can be modified Harden: Specifies that inherited properties are fixed |
||
| Type Properties | Types | Specifies the type of relationship | ||
| Null Option | Indicates whether null values are allowed in the relationship |
Nulls Allowed: Indicates that null values are permitted Nulls Not Allowed: Indicates that null values are not permitted |
||
| Relationship Properties | Child-To-Parent Phrase | Specifies the verb phrase describing the relationship from child to parent | ||
| Parent-to-Child Phrase | Specifies the verb phrase describing the relationship from parent to child | |||
| Cardinality Properties | Cardinality | Specifies the relationship cardinality between parent and child entities |
Zero, One, or More: Specifies optional many relationship One or More (P): Specifies mandatory many relationship Zero or One (Z): Specifies optional one relationship |
|
| Cardinality Value | Specifies the numeric representation of the cardinality | |||
| Role Name | Migrated Key/Index | Key Group | Specifies the key group that is migrated through the relationship | |
| Role Name Info | Role Name Info | Specifies the role name used to identify the relationship | ||
| Migrated Attribute | Indicates whether the attribute is migrated through the relationship | |||
| Role Name | Specifies the role name assigned to the migrated attribute | |||
| Ri Actions | RI Actions | Child Delete Rule | Specifies the action applied to child records when the parent is deleted |
Restrict: Prevents deletion if dependent records exist Cascade: Deletes dependent child records automatically Set Null: Sets foreign key values to null Set Default: Sets foreign key values to default No Action: Defers constraint handling |
| Child Insert Rule | Specifies the action applied when inserting child records | |||
| Child Update Rule | Specifies the action applied when updating child records | |||
| Parent Delete Rule | Specifies the action applied when deleting parent records | |||
| Parent Insert Rule | Specifies the action applied when inserting parent records | |||
| Parent Update Rule | Specifies the action applied when updating parent records | |||
| Match Option | Specifies the matching behavior for referential integrity |
Match Simple: Specifies simple matching of columns Match Full: Specifies full matching across all columns Match Partial: Specifies partial matching |
||
| Trigger Template | Trigger Template | Child Delete Trigger Template | Specifies the trigger template for child delete operations | |
| Child Insert Trigger Template | Specifies the trigger template for child insert operations | |||
| Child Update Trigger Template | Specifies the trigger template for child update operations | |||
| Parent Delete Trigger Template | Specifies the trigger template for parent delete operations | |||
| Parent Insert Trigger Template | Specifies the trigger template for parent insert operations | |||
| Parent Update Trigger Template | Specifies the trigger template for parent update operations | |||
| Style | Style Inheritance | Relationship Font Inherited From Parent | Indicates whether the font style is inherited from the parent object | |
| Relationship Text Color Inherited From Line | Indicates whether text color is inherited from the relationship line | |||
| Relationship Line Color Inherited From Parent | Indicates whether line color is inherited from the parent | |||
| Theme Text Color | Relationship Font Color | Specifies the color of the relationship text | ||
| Theme Line Style | Relationship Line Width | Specifies the width of the relationship line | ||
| Relationship Line Color | Specifies the color of the relationship line. |
Row Access Policies
| Tab | Section | Property | Description |
|---|---|---|---|
| Properties | Properties | Name | Specifies the name of the row access policy |
| Use Replace Syntax | Indicates whether the row access policy should be replaced if it already exists | ||
| If Not Exists | Indicates whether the row access policy is created only if it does not already exist | ||
| Generate | Indicates whether the row access policy is created only if it does not already exist | ||
| General Options | Returns Body | Specifies the SQL expression or logic that determines row-level access |
Schemas
| Tab | Section | Property | Description | Additional Information |
|---|---|---|---|---|
| Properties | Name | Specifies the name of the schema | ||
| Owner | Specifies the owner of the schema | |||
| Generate | Indicates whether the schema is included in script generation | |||
| Use Replace Syntax | Indicates whether the schema should be replaced if it already exists | |||
| If Not Exists | Indicates whether the schema is created only if it does not already exist | |||
| Transient | Indicates whether the schema is created as a transient schema | |||
| Data Retention Time (In Days) | Specifies the number of days for which historical data can be accessed using Time Travel | |||
| DEFAULT_DDL_COLLATION | Specifies the default collation applied to objects created in the schema | |||
| With Managed Access | Indicates whether the schema uses managed access for privilege control | |||
| Clone Schema | Specifies the source schema used for cloning | |||
| At or Before | Specifies the point in time for cloning using Time Travel |
At: Specifies cloning at an exact point in time Before: Specifies cloning to a state before a specific point |
||
| Time Type | Specifies the type of reference used for Time Travel |
Timestamp: Specifies an exact date and time Offset: Specifies a time difference relative to current time Statement: Specifies a query ID as the reference point |
||
| Point | Specifies the reference point used for cloning the schema | |||
| Tags List | Name | Specifies the name of the tag assigned to the schema | ||
| Value | Specifies the value associated with the tag |
Security Integrations
| Tab | Section | Property | Description | Additional Information |
|---|---|---|---|---|
| Properties | Properties | Name | Specifies the name of the security integration | |
| Use Replace Syntax | Indicates whether the security integration should be replaced if it already exists | |||
| If Not Exists | Indicates whether the security integration is created only if it does not already exist | |||
| Generate | Indicates whether the security integration is included in script generation | |||
| General Options | Security Integration Type | Specifies the type of security integration | ||
| Enabled | Indicates whether the security integration is active | |||
| OAuth Issue Refresh Tokens | Indicates whether refresh tokens are issued for OAuth clients | |||
| OAuth Refresh Token Validity | Specifies the validity period for OAuth refresh tokens | |||
| OAuth Client | Specifies the OAuth client type |
Partner Application: Specifies a predefined partner application Custom: Specifies a custom OAuth client configuration |
||
| OAuth Partner Application | Partner Application Value | Specifies the partner application used for integration |
Tableau Desktop: Specifies Tableau Desktop integration Tableau Server: Specifies Tableau Server integration |
|
| OAuth Custom Client | OAuth client Type | Specifies the type of OAuth client |
Confidential: Specifies a secure client requiring authentication Public: Specifies a client that does not require secret-based authentication |
|
| Allow Non-TLS Redirect URI | Indicates whether non-secure (non-TLS) redirect URIs are allowed | |||
| OAuth Redirect URI | Specifies the redirect URI used for OAuth authentication flow | |||
| OAuth Enforce PKCE | Indicates whether Proof Key for Code Exchange (PKCE) is enforced for OAuth security | |||
| Network Policy | Specifies the network policy applied to the integration | |||
| OAuth Client RSA Public Key | Specifies the RSA public key used for OAuth client authentication | |||
| OAuth Client RSA Public Key2 | Specifies the secondary RSA public key used for OAuth client authentication |
Sequences
| Tab | Section | Property | Description |
|---|---|---|---|
| Properties | Name | Specifies the name of the sequence | |
| Use Replace Syntax | Indicates whether the sequence should be replaced if it already exists | ||
| If Not Exists | Indicates whether the sequence is created only if it does not already exist | ||
| Do Not Generate | Indicates whether the sequence is excluded from script generation | ||
| Starting Value | Specifies the initial value of the sequence | ||
| Increment By | Specifies the value by which the sequence increments for each new entry |
Stages
| Tab | Section | Property | Description | Additional Information |
|---|---|---|---|---|
| Properties | Is Temporary | Indicates whether the stage is created as a temporary stage | ||
| Stage Type | Specifies the type of stage |
Internal: Specifies an internal stage managed within the system External: Specifies a stage referencing external cloud storage |
||
| Use Replace Syntax | Indicates whether the stage should be replaced if it already exists | |||
| If Not Exists | Indicates whether the stage is created only if it does not already exist | |||
| Generate | Indicates whether the stage is included in script generation | |||
| External Stage Parameters | General Properties | External Stage Type | Specifies the type of external storage used for the stage |
AWS S3 Bucket: Specifies Amazon S3 storage Google Cloud Storage Bucket: Specifies Google Cloud Storage Microsoft Azure Container: Specifies Azure Blob Storage |
| URL | Specifies the location of the external storage | |||
| Storage Integration | Specifies the storage integration used to access external storage | |||
| Credentials Options: | Aws Key ID | Specifies the access key ID for AWS authentication | ||
| Aws secret key | Specifies the secret key for AWS authentication | |||
| Aws Token | Specifies the temporary security token for AWS access | |||
| Aws Role | Specifies the AWS role used for accessing storage | |||
| Azure Sas Token | Specifies the shared access signature (SAS) token for Azure authentication | |||
| Encryption Optionss | External Stage Encryption Type | Specifies the encryption method used for external storage |
Azure CSE: Specifies client-side encryption for Azure AWS CSE: Specifies client-side encryption for AWS AWS SSE S3: Specifies server-side encryption using S3-managed keys AWS SSE KMS: Specifies server-side encryption using AWS KMS |
|
| External Stage Encryption Kms Key ID | Specifies the KMS key ID used for encryption | |||
| External Stage Encryption Master Key | Specifies the master key used for encryption | |||
| Directory Parameters | Enable | Indicates whether directory table functionality is enabled | ||
| Auto Refresh | Indicates whether directory metadata is refreshed automatically |
TRUE: Enables automatic refresh FALSE: Disables automatic refresh |
||
| Notification Integration | Specifies the notification integration used for auto refresh | |||
| Subpath | Specifies the subdirectory path within the stage location | |||
| Stage Format Options | File Format Name | Use Existing File Format | Indicates whether an existing file format is used | |
| File Format Options | Stage File Format Type |
Specifies the file format used for data files |
CSV: Specifies comma-separated values format JSON: Specifies semi-structured JSON format AVRO: Specifies Avro format ORC: Specifies columnar ORC format PARQUET: Specifies columnar Parquet format XML: Specifies XML format |
|
| Stage Copy Options | Action On Error(while Copy) | Specifies the action to take when an error occurs during data loading |
Continue: Continues processing remaining data Skip file: Skips the file with errors Skip file with Specification: Skips files based on defined conditions Abort Statement: Stops execution on error |
|
| Skip File if Error count | Specifies the threshold for skipping a file based on error count | |||
| Copy Size Limit | Specifies the maximum size of data to load during copy | |||
| Purge After Copy | Indicates whether files are removed from the stage after loading | |||
| Return Failed Only | Indicates whether only failed records are returned | |||
| Enforce Length | Indicates whether data length constraints are enforced | |||
| Match By Column Name | Indicates whether columns are matched by name during loading | |||
| Truncate Columns | Indicates whether column values are truncated to fit the target schema | |||
| Force Load(Reload) All Files | Indicates whether all files are reloaded, regardless of load history | |||
| Copy Statement | Specifies the generated COPY INTO statement for data loading | |||
| Tags List | Name | Specifies the name of the tag assigned to the stage | ||
| Value | Specifies the value associated with the tag |
Storage Integrations
| Tab | Section | Property | Description | Additional Information |
|---|---|---|---|---|
| General | Storage Integration Enabled | Indicates whether the storage integration is enabled | ||
| Storage Allowed Locations | Specifies the external storage locations that are permitted for access | |||
| Storage Blocked Locations | Specifies the external storage locations that are restricted from access | |||
| Provider | Specifies the cloud provider used for the storage integration |
S3: Specifies Amazon S3 as the storage provider GCS: Specifies Google Cloud Storage as the storage provider Azure: Specifies Microsoft Azure Storage as the storage provider |
||
| Storage Aws Role Arn | Specifies the Amazon Resource Name (ARN) of the AWS role used for accessing S3 storage | |||
| Azure Tenant ID | Specifies the Azure Active Directory tenant ID used for authentication |
Stored Procedures
| Tab | Section | Property | Description | Additional Information |
|---|---|---|---|---|
| Properties | Name | Specifies the name of the stored procedure | ||
| Schema | Specifies the schema in which the stored procedure is created | |||
| Use ALTER Syntax | Indicates whether the stored procedure is modified using ALTER syntax | |||
| Generate | Indicates whether the stored procedure is included in script generation | |||
| Comments | Specifies descriptive information for the stored procedure | |||
| Snowflake Return Data type | Specifies the data type returned by the stored procedure | |||
| Not Null | Indicates whether the stored procedure returns non-null values. | |||
| Language Type | Specifies the programming language used to implement the stored procedure | Javascript: Specifies JavaScript-based implementation | ||
| Call Return Type | Specifies how the stored procedure behaves when handling null inputs |
Called On Null Input: Executes even when input is null Returns Null on Null Input: Returns null if input is null Strict: Does not execute when input is null |
||
| Volatile Or Immutable | Specifies whether the stored procedure returns consistent results for the same input |
Volatile: Output may vary for the same input Immutable: Output remains consistent for the same input |
||
| Execution Type | Specifies the execution context of the stored procedure |
Caller: Executes with the caller’s privileges Owner: Executes with the owner’s privileges |
||
| As Stored_Procedure Definition | Specifies the body or logic of the stored procedure | |||
| Parameter Options | Name | Specifies the name of the parameter | ||
| Physical Data Type | Specifies the data type of the parameter | |||
| Output Parameter | Indicates whether the parameter is an output parameter | |||
| Stored Procedure Definition | As Stored Procedure Definition | Specifies the implementation code of the stored procedure | Use |
|
| Code | Specifies the stored procedure logic defined in the editor | |||
| Expanded | Displays the SQL definition of the stored procedure |
Provides a built-in editor to view and manage the SQL definition. The following options are available: Fold All / Unfold All – Specifies options to collapse or expand the SQL content Go to Line – Specifies navigation to a specific line in the script Validate – Specifies validation of the SQL syntax Read Only – Indicates whether the SQL editor is in read-only mode SQL – Indicates whether editing mode is enabled |
||
| Sql | Displays the SQL definition for the stored procedure |
Provides a built-in editor to view and manage the SQL definition. The following options are available: Fold All / Unfold All – Specifies options to collapse or expand the SQL content Go to Line – Specifies navigation to a specific line in the script Validate – Specifies validation of the SQL syntax Read Only – Indicates whether the SQL editor is in read-only mode SQL – Indicates whether editing mode is enabled |
||
| Object Creation Order | Name | Specifies the object name in the creation order list | ||
| Object Order | Specifies the sequence in which the stored procedure is created |
Streams
| Tab | Section | Property | Description | Additional information |
|---|---|---|---|---|
| Properties | Name | Specifies the name of the stream | ||
| Use Replace Syntax | Indicates whether the stream should be replaced if it already exists | |||
| If Not Exists | Indicates whether the stream is created only if it does not already exist | |||
| Do Not Generate | Indicates whether the stream is excluded from script generation | |||
| General Options | Schema | Specifies the schema in which the stream is created | ||
| Table Name | Specifies the source table that the stream tracks for changes | |||
| Is Append | Indicates whether the stream captures only appended (inserted) data | |||
| Show Initial Rows | Indicates whether existing table rows are included when the stream is created. | |||
| At or Before | Specifies the point in time for creating the stream using Time Travel |
At: Specifies creation at an exact point in time Before: Specifies creation before a specific point |
||
| Time Type | Specifies the type of reference used for Time Travel |
Timestamp: Specifies an exact date and time Offset: Specifies a relative time difference from the current time Statement: Specifies a query ID as the reference point |
||
| Point | Specifies the reference point for Time Travel when creating the stream | |||
| Clone | Clone Stream | Specifies the source stream used to create a clone |
Subject Areas
| Tab | Section | Property | Description | Additional Information |
|---|---|---|---|---|
| Properties | Name | Specifies the name of the subject area | ||
| Auto Populate | Indicates whether objects are automatically added to the subject area | |||
| General | Common Properties | Author | Specifies the author of the subject area | |
| Exclude Dangling Relationships From Schema generation | Indicates whether incomplete relationships are excluded from schema generation | |||
| Optional Theme | Theme | Specifies the theme applied to the subject area |
Classic Theme: Specifies standard visual styling DARK Theme: Specifies a dark visual theme Default Theme: Specifies the system default theme |
|
| Members | Available Objects | Name | Specifies the name of the available object | |
| Type | Indicates the type of object | |||
| Included Objects | Name | Specifies the name of the object included in the subject area | ||
| Type | Indicates the type of the included object | |||
| Definition | Specifies the detailed description or purpose of the subject area | Use |
Tables
| Tab | Section | Property | Description | Additional Information |
|---|---|---|---|---|
| Properties | Table Properties | Harden Strategy | Specifies how inherited table properties are applied |
|
| Physical Only | Indicates whether the table exists only in the physical model | |||
| Database | Specifies the database in which the table is created | |||
| Schema | Specifies the schema in which the table is created | |||
| Generate | Indicates whether the table is included in script generation | |||
| General Options | Table Type | Specifies the type of table |
Temporary: Exists only for session Global Temporary: Exists temporarily but visible globally |
|
| Data Retention Time (In Days) | Specifies the number of days data is retained for Time Travel | |||
| DEFAULT_DDL_COLLATION | Specifies the default collation applied to table objects | |||
| Copy Grants | Indicates whether access privileges are copied from the source | |||
| Like Options | Like Table | Specifies creation of a table based on an existing table structure | ||
| Clone Options | Clone Table | Specifies cloning of an existing table | ||
| At or Before | Specifies the point in time for cloning | |||
| Time Type | Specifies the reference type for Time Travel |
: |
||
| Point | Specifies the reference point used for cloning | |||
| Columns | Name | Specifies the column name | ||
| Physical Data Type | Specifies the datatype of the column | |||
| Type | Indicates the column type classification | |||
| Null Option Type | Indicates whether null values are allowed for the column | |||
| Sql | Displays the SQL definition of the table |
Provides a built-in editor to view and manage the SQL definition. The following options are available: Fold All / Unfold All – Specifies options to collapse or expand the SQL content Go to Line – Specifies navigation to a specific line in the script Validate – Specifies validation of the SQL syntax Read Only – Indicates whether the SQL editor is in read-only mode SQL – Indicates whether editing mode is enabled |
||
| Additional Options | Additional Options | Cluster By | Specifies the clustering key for the table | |
| Max Data Extension Time In Days | Specifies the maximum data extension period | |||
| Row Access Policy | Specifies the row-level access policy applied to the table | |||
| Row Access Policy Columns | Column | Specifies columns used in the row access policy | ||
| Selected | Indicates whether the column is included | |||
| Stage Format Options | File Format Name | Use Existing File Format | Specifies the file format used | |
| File Format Options | Stage File Format Type | Specifies the format of input or output files used for data loading or unloading |
Based on the selected file format type, additional format-specific properties are enabled. CSV – Specifies comma-separated values format for structured data JSON – Specifies JavaScript Object Notation format for semi-structured data AVRO – Specifies Avro format for schema-based binary data ORC – Specifies optimized columnar format for large-scale data processing PARQUET – Specifies columnar storage format for high-performance analytics XML – Specifies extensible markup language format for hierarchical data None – Specifies that no file format is selected |
|
| Stage Copy Options | Action On Error(while Copy) | Specifies behavior on error |
|
|
| Copy Size Limit | Specifies the size limit during data load | |||
| Purge After Copy | Indicates whether staged files are removed after loading | |||
| Return Failed Only | Indicates whether only failed records are returned | |||
| Enforce Length | Indicates whether column length constraints are enforced | |||
| Match By Column Name | Specifies column matching behavior |
|
||
| Truncate Columns | Indicates whether oversized data is truncated | |||
| Force Load(Reload) All Files | Indicates whether all files are reloaded | |||
| External Table Options | External Table Properties | External Stage Type | Specifies external storage type |
|
| External Stage Location | Specifies the external data path | |||
| Refresh On Create | Indicates whether metadata is refreshed during creation | |||
| Auto Refresh | Indicates whether metadata is refreshed automatically | |||
| Pattern | Specifies file selection pattern | |||
| Table Format | Specifies the table format | |||
| Partition By | Column | Specifies partitioning columns | ||
| Dynamic Table/Dynamic Iceberg Table Properties | Target Lag | Specifies acceptable data latency | ||
| Warehouse | Specifies the compute resource used | |||
| Refresh Mode | Specifies refresh behavior |
|
||
| Initialize | Specifies initialization timing |
|
||
| Require User | Indicates whether user action is required | |||
| Iceberg Table Options | Iceberge Catalog | Specifies the catalog used to manage the Iceberg table metadata | ||
| External Volume | Specifies the external storage volume | |||
| Catalog | Specifies the external catalog | |||
| Base Location | Specifies the storage base path | |||
| Catalog Sync | Indicates synchronization with the external catalog | |||
| Storage Serialization Policy | Specifies serialization behavior |
Compatible: Ensures compatibility with standard storage formats and external systems Optimized: Enhances performance and storage efficiency for the target platform |
||
| Change Tracking | Indicates whether data changes are tracked | |||
| Aggregation Policy | Specifies aggregation rules | |||
| Catalog | Specifies the external catalog used for Iceberg table integration | |||
| Catalog Table Name | Specifies the table name in the external catalog | |||
| Catalog Namespace | Specifies the namespace in the external catalog | |||
| Replace Invalid Characters | Indicates whether invalid characters are replaced | |||
| Auto Refresh | Indicates whether metadata is refreshed automatically | |||
| Metadata File Path | Specifies the metadata file location | |||
| Contact | Specifies the contact information for the table | |||
| Hybrid Table As Select | Select Statement | Use |
||
| Tags List | Name | Specifies the tag name | ||
| Value | Specifies the tag value | |||
| Nullability | Nullable Members | Columns | Specifies the columns for which nullability settings are defined | |
| Null Option | Indicates whether null values are allowed | |||
| Business Terms Mapping | Name | Specifies the business term name | ||
| Definition | Specifies the meaning of the business term | |||
| Description | Specifies additional descriptive details | |||
| SDI | Indicates whether the term belongs to SDI classification | |||
| SDI Classes | Specifies SDI classification categories | |||
| Shortcut | Attributes | Allow Name Edits in Clone | Indicates whether name changes are allowed in clones | |
| Allow Comment Edits in Clone | Indicates whether comments can be modified in clones | |||
| Collections | Allow Attribute Additions in Clone | Indicates whether attributes can be added in clones | ||
| Allow Attribute Deletions in Clone | Indicates whether attributes can be deleted in clones | |||
| Shortcuts | Name | Specifies the shortcut name | ||
| Type | Indicates the shortcut type | |||
| Parent | Specifies the parent object | |||
| Parent Type | Indicates the type of parent object |
File Formats
| Tab | Property | Description | Additional Information |
|---|---|---|---|
|
Stage Format Options |
Stage File Format Type | Specifies the format of the input files (for data loading) or output files (for data unloading) |
Based on the type you select, additional properties are enabled. For more information, refer to Snowflake documentation. |
Stages
|
Tab |
Property |
Description |
Additional Information |
|---|---|---|---|
|
General |
Is Temporary | Specifies whether the stage is temporary | |
|
External Stage Parameters These properties are applicable only when the Stage Type property is set to External. |
External Stage Type | Specifies the external stage name | |
| URL | Specifies the external location's URL used to store data files for loading and unloading | ||
| Storage Integration | Specifies the name of the storage integration used to delegate authentication responsibility | ||
| Aws Key ID | Specifies the security credentials required to connect to AWS and access a private or protected bucket | These fields are available based on the External Stage Type. | |
| Aws secret key | |||
| Aws Token | |||
| Aws Role | Specifies the role to be used to identify instead of the security credentials | ||
| Azure Sas Token | Specifies the SAS token to connect to Azure and access a private or protected container | ||
| External Stage Encryption Type | Specifies the encryption type to be used | ||
| External Stage Encryption Kms Key ID | Specifies the ID of the KMS-managed key used to encrypt files unloaded into the bucket | ||
| External Stage Encryption Master Key | Specifies the client-side master key used to encrypt or decrypt the files in a container | ||
| Enable | Specifies whether to add a directory table to the stage object | ||
| Auto Refresh | Specifies whether to enable a trigger to automatically refresh the directory table | ||
| Subpath | Specifies the URL for the external database location to store data files | ||
|
Stage Format Options |
Use Existing File Format | Specifies whether the existing file format must be used for the stage | |
| Stage File Format Type | Specifies the types of files for the stage | Depending on the format that you set, other corresponding properties are available. | |
|
Stage Copy Options |
Action On Error (while Copy) | Specifies the action to be performed when an error occurs while loading data from a file | |
| Copy Size Limit | Specifies the maximum size (in bytes) of data to be loaded for a COPY statement | ||
| Purge After Copy | Specifies whether data files must be to purged automatically after data is successfully loaded | ||
| Returned Failed Only | Specifies whether only the files that failed to load are returned in the statement result | ||
| Enforce Length | Specifies whether text strings that exceed the target column length must be truncated | ||
| Match By Column Name | Specifies whether to load semi-structured data into columns in the target table that match corresponding columns represented in the data | ||
| Truncate Columns | Specifies whether text strings that exceed the target column length must be truncated | ||
| Force Load (Reload) All Files | Specifies whether all files must be loaded, irrespective of whether they have been loaded previously and have not changed since they were loaded |
File Formats
|
Tab |
Property |
Description |
Additional Information |
|---|---|---|---|
|
Stage Format Options |
Stage File Format Type | Specifies the format of the input files (for data loading) or output files (for data unloading) |
Based on the type you select, additional properties are enabled. For more information, refer to Snowflake documentation. |
Storage Integrations
|
Tab |
Property |
Description |
Additional Information |
|---|---|---|---|
|
General |
Storage Integration Enabled | Specifies whether storage integration is enabled for usage in stages | |
| Storage allowed Locations | Limits the external stages that use the integration to reference one or more storage locations | Specifies the URL of the container | |
| Storage Blocked Locations | Prohibits external stages that use the integration from referencing one or more storage locations | Specifies the URL of the container | |
| Provider | Specifies the cloud storage provider that stores your data files | ||
| Storage Aws Role Arn | Specifies the Amazon Resource Name (ARN) of the AWS identity and access management (IAM) role that grants privileges on the S3 bucket containing your data files | This field is available when the Provider is set to S3 | |
| Azure Tenant ID | Specifies the ID of your Office 365 tenant that the allowed and blocked storage accounts belong to | This field is available when the Provider is set to Azure |
Tags
|
Tab |
Property |
Description |
Additional Information |
|---|---|---|---|
|
General |
Storage Integration Enabled | Specifies whether storage integration is enabled for usage in stages | |
| Storage allowed Locations | Limits the external stages that use the integration to reference one or more storage locations | Specifies the URL of the container | |
| Storage Blocked Locations | Prohibits external stages that use the integration from referencing one or more storage locations | Specifies the URL of the container | |
| Provider | Specifies the cloud storage provider that stores your data files | ||
| Storage Aws Role Arn | Specifies the Amazon Resource Name (ARN) of the AWS identity and access management (IAM) role that grants privileges on the S3 bucket containing your data files | This field is available when the Provider is set to S3 | |
| Azure Tenant ID | Specifies the ID of your Office 365 tenant that the allowed and blocked storage accounts belong to | This field is available when the Provider is set to Azure |
Tasks
|
Tab |
Property |
Description |
|---|---|---|
|
General |
Warehouse | Specifies the virtual warehouse that is used to execute the task |
| Schedule Type | Specifies the schedule for running the task periodically | |
| Schedule Time | Specifies an interval (in minutes) of wait time inserted between runs of the task | |
| USER_TASK_TIMEOUT_MS | Specifies the time limit (in milliseconds) on a single run of the task before it times out | |
| After Task | Specifies the task after which this task must run | |
| Sql Statement | Specifies the SQL statement or a call to a stored procedure that must be executed when the task runs | |
| When Boolean Expression | Specifies a Boolean SQL expression that validates the conditions of the expression to determine whether to execute the task | |
| Stream as Argument | Specifies the stream to be used as an argument for the task | |
| Clone Task | Specifies to create a clone of the specified source task | |
|
Session Parameters |
Abort Detached Query | Specifies the action that must be performed for in-progress queries if connectivity is lost due to abrupt termination of a session |
| Auto Commit | Specifie whether a DML statement, when executed without an active transaction, is automatically committed after the statement successfully completes | |
| Date Input Format | Specifies the input format for the DATE data type | |
| Date Output Format | Specifies the output format for the DATE data type | |
| Error On Nondeterministic Merge | In cases where the MERGE command is used to update or delete a target row that joins multiple source rows, specifies whether an error must be returned when the system cannot determine the action to perform on the target row | |
| Error On Nondeterministic Update | In cases where the UPDATE command is used to update or delete a target row that joins multiple source rows, specifies whether an error must be returned when the system cannot determine the action to perform on the target row | |
| Lock Timeout | Specifies the time in seconds to wait while trying to lock a resource, before timing out and aborting the statement | |
| Query Tag | Specifies a string that can be used to tag queries and other SQL statements executed within a session | |
| Row Per Resultset | Specifies the maximum number of rows returned in a result set | |
| Statement Timeout In Seconds | Specifies the time in seconds, after which the system cancels a running SQL statement | |
| Timestamp Day Is Always 24H | For expressions that span multiple days, specifies whether the DATEADD function always considers a day to be 24 hours | |
| Timestamp Input Format | Specifies the input format for the TIMESTAMP data type alias | |
| Timestamp LTZ Output Format | Specifies the display format for the TIMESTAMP_LTZ data type | |
| Timestamp NTZ Output Format | Specifies the display format for the TIMESTAMP_NTZ data type | |
| Timestamp Output Format | Specifies the display format for the TIMESTAMP data type alias | |
| Timestamp Type Mapping | Specifies the TIMESTAMP_* variation that the TIMESTAMP data type alias maps to | |
| Timestamp TZ Output Format | Specifies the display format for the TIMESTAMP_TZ data type | |
| Timezone | Specifies the time zone for the session | |
| Time Input Format | Specifies the input format for the TIME data type | |
| Time Output Format | Specifies the display format for the TIME data type | |
| Transaction Default Isolation Level | Specifies the isolation level for transactions in the user session | |
| Two Digit Century Start | Specifies the century start year for 2-digit years | |
| Unsupported DDL Action | Specifies whether an unsupported value specified for a constraint property returns an error | |
| Used Cached Result | Specifies whether to reuse cached query results when a matching query is submitted |
Themes
Note: These properties are applicable to the Classic, Dark, and Default themes. All themes provide the same configuration options for customizing fonts, colors, fill, lines,
| Tab | Section | Property | Description |
|---|---|---|---|
| Properties | Name | Specifies the name of the theme | |
| Diagram Fill | Specifies the background color of the diagram canvas | ||
| Entity Fill | Specifies the background color of the diagram canvas | ||
| FK Attribute Font | Specifies the font style applied to foreign key attribute | ||
| FK Attribute Fill | Specifies the fill color for foreign key attributes | ||
| Default Font | Specifies the default font used across the theme | ||
| Entity Font | Specifies the font used for entity names | ||
| Attribute Font | Specifies the font used for attribute names | ||
| Defaults | Font Settings | Font Options | Specifies the default font configuration for diagram elements |
| Fill Settings | Fill Options | Specifies the default fill color settings | |
| Line Settings | Line Options | Specifies the line style for relationships and connectors | |
| Outline Settings | Outline Options | Specifies the border style for diagram objects | |
| Diagram Fill | Fill Options | Specifies the default background color of the diagram | |
| Entity | Name Display | Font Options | Specifies the font used to display entity names |
| Fill Options | Specifies the background color for entity names | ||
| Outline Options | Specifies the border styling for entity name display | ||
| Definition Display | Font Options | Specifies the font used for displaying entity definitions | |
| Fill Options | Specifies the background color for definitions | ||
| Outline Options | Specifies the border styling for definition sections | ||
| Attribute | Owned Attribute Font | Font Options | Specifies the font applied to owned (non-key) attributes |
| Foreign Key Style Inheritance | Font Inheritance Type | Specifies whether foreign key attributes inherit font settings | |
| Color Inheritance Type | Specifies whether foreign key attributes inherit color settings | ||
| Foreign Key Attribute Font | Font Options | Specifies the font used for foreign key attributes | |
| Foreign Key Attribute Color | Color | Specifies the color applied to foreign key attributes | |
| Key | Key Display Preference | Style Preference | Specifies how key styles are displayed when multiple key types apply |
| Alternate Key (AK) Attribute Font | Font Options | Specifies the font used for alternate key attributes | |
| Inversion Entry (IE) Attribute Font | Font Options | Specifies the font used for inversion entry attributes | |
| View | Name Display | Font Options | Specifies the font used to display view names |
| Fill Options | Specifies the background color for view names | ||
| Outline Options | Specifies the border styling for view name display | ||
| Definition Display | Font Options | Specifies the font used for view definitions | |
| Fill Options | Specifies the background color of the definition section | ||
| Outline Options | Specifies the border styling for the definition section | ||
| Attribute Display Fonts | Font Options (Left / Right panels) | Specifies the font used for displaying attributes within views | |
| Relationship | Style Inheritance | Relationship Font Inherited From Parent | Indicates whether the relationship text font is inherited from the parent object |
| Relationship Line Color Inherited From Parent | Indicates whether the relationship line color is inherited from the parent element | ||
| Relationship Text Color Inherited From Line | Indicates whether the relationship text color follows the line color | ||
| Relationship Text Font | Font Options | Specifies the font used for relationship labels | |
| Relationship Text Color | Color | Specifies the color used for relationship text | |
| Relationship Line Style | Line Width | Specifies the thickness of relationship lines | |
| Color | Specifies the color of relationship lines | ||
| Subtype Symbol | Style Inheritance | Subtype Symbol Font Inherited From Parent | Indicates whether subtype symbol font is inherited from the parent |
| Subtype Symbol Line Color Inherited From Parent | Indicates whether the subtype symbol line color is inherited | ||
| Subtype Symbol Text Color Inherited From Line | Indicates whether subtype symbol text color follows the line color | ||
| Subtype Symbol Text Font | Font Options | Specifies the font used for subtype symbols | |
| Subtype Symbol Text Color | Color | Specifies the color of subtype symbol text | |
| Subtype Symbol Style | Line Width | Specifies the thickness of subtype symbol lines | |
| Color | Specifies the color used for subtype symbol lines | ||
| Fill Options | Specifies the fill color for subtype symbols | ||
| Annotation/Shape | Annotation/Shape Text Font | Font Options | Specifies the font used for annotation and shape text |
| Annotation/Shape Text Handling | Annotation Text Vertical Alignment | Specifies the vertical alignment of annotation text | |
| Annotation Text Horizontal Alignment | Specifies the horizontal alignment of annotation text | ||
| Annotation Text Handling Style | Specifies how text is displayed within shapes | ||
| Annotation/Shape Fill | Fill Options | Specifies the background color of annotation or shape objects | |
| Annotation/Shape Line | Line Options | Specifies the line style used for annotation borders | |
| Specifies the line style used for annotation borders. | Outline Options | Specifies the outline style for annotation shapes |
Users
| Tab | Section | Property | Description |
|---|---|---|---|
| Properties | Name | Specifies the name of the user | |
| Use Replace Syntax | Indicates whether the user should be replaced if it already exists | ||
| If Not Exists | Indicates whether the user is created only if it does not already exist | ||
| Do Not Generate | Indicates whether the user is excluded from script generation | ||
| User Options | Password | Specifies the password of the user, enclosed in quotation marks | |
| Login Name | Specifies the name that a user uses to log in to the system | ||
| User Display Name | Specifies the username that is displayed in the Snowflake web interface | ||
| User First Name | Specifies the user's first name | ||
| User Middle Name | Specifies the user's middle name | ||
| User Last Name | Specifies the user's last name | ||
| Email Address | Specifies the user's email address | ||
| Must Change Password | Specifies whether the user is forced to change their password on next login into the system | ||
| User Disabled | Specifies whether the user is disabled | ||
| Days To Expiry LogIn | Specifies the number of days after which the user status is set to Expired | ||
| Mins To unlock | Specifies the number of minutes until the temporary lock on the user login is cleared | ||
| Default Warehouse | Specifies the virtual warehouse that is active by default for the user’s session | ||
| Default Namespace | Specifies the namespace (database only or database and schema) that is active by default for the user’s session | ||
| Default Role | Specifies the role that is active by default for the user’s session | ||
| Default Secondary Roles | |||
| Ext Authn Duo | Specifies whether Duo Security is enabled for the user | ||
| Ext Authn UID | Specifies the authorization ID used for Duo Security | ||
| Mins To Bypass MFA | Specifies the number of minutes to temporarily bypass multi-factor authentication (MFA) for the user | ||
| Disable MFA | Disables MFA for the user | ||
| RSA Public Key | Specifies the user’s RSA public key that is used for key pair authentication | ||
| RSA Public Key 2 | Specifies the user’s second RSA public key that is used to rotate the public and private keys for key pair authentication | ||
| Tags List | Name | Specifies the name of the tag | |
| Value | Specifies the value of the available tag | ||
| Session Parameters | Abort Detached Query | Specifies the action that must be performed for in-progress queries if connectivity is lost due to abrupt termination of a session | |
| Auto Commit | Specifies whether a DML statement, when executed without an active transaction, is automatically committed after the statement successfully completes | ||
| Date Input Format | Specifies the input format for the DATE data type | ||
| Date Output Format | Specifies the output format for the DATE data type | ||
| Error On Nondeterministic Merge | In cases where the MERGE command is used to update or delete a target row that joins multiple source rows, specifies whether an error must be returned when the system cannot determine the action to perform on the target row | ||
| Error On Nondeterministic Update | In cases where the UPDATE command is used to update or delete a target row that joins multiple source rows, specifies whether an error must be returned when the system cannot determine the action to perform on the target row | ||
| Lock Timeout | Specifies the time in seconds to wait while trying to lock a resource, before timing out and aborting the statement | ||
| Query Tag | Specifies a string that can be used to tag queries and other SQL statements executed within a session | ||
| Rows Per Resultset | Specifies the maximum number of rows returned in a result set | ||
| Statement Timeout In Seconds | Specifies the time in seconds, after which the system cancels a running SQL statement | ||
| Timestamp Day Is Always 24H | For expressions that span multiple days, specifies whether the DATEADD function always considers a day to be 24 hours | ||
| Timestamp Input Format | Specifies the input format for the TIMESTAMP data type alias | ||
| Timestamp LTZ Output Format | Specifies the display format for the TIMESTAMP_LTZ data type | ||
| Timestamp NTZ Output Format | Specifies the display format for the TIMESTAMP_NTZ data type | ||
| Timestamp Output Format | Specifies the display format for the TIMESTAMP data type alias | ||
| Timestamp Type Mapping | Specifies the TIMESTAMP_* variation that the TIMESTAMP data type alias maps to | ||
| Timestamp TZ Output Format | Specifies the display format for the TIMESTAMP_TZ data type | ||
| Timezone | Specifies the time zone for the session | ||
| Time Input Format | Specifies the input format for the TIME data type | ||
| Time Output Format | Specifies the display format for the TIME data type | ||
| Transaction Default Isolation Level | Specifies the isolation level for transactions in the user session | ||
| Two Digit Century Start | Specifies the century start year for 2-digit years | ||
| Unsupported DDL Action | Specifies whether an unsupported value specified for a constraint property returns an error | ||
| Use Cached Result | Specifies whether to reuse cached query results when a matching query is submitted |
Views
| Tab | Section | Property | Description | Additional Information |
|---|---|---|---|---|
| Properties | Name | Specifies the name of the view | ||
| Comments | Specifies descriptive information for the view | |||
| Physical Name | Specifies the physical name of the view in the database | |||
| Generate | Indicates whether the view is included in script generation | |||
| Is Recursive | Indicates whether the view supports recursive queries | |||
| Is Secure | Indicates whether the view is created as a secure view | |||
| Copy Grants | Indicates whether privileges are copied from the source object | |||
| Schema | Specifies the schema in which the view is created | |||
| General | General Options | Schema Binding | Specifies the schema binding behavior of the view |
BINDING: Specifies strict schema dependency COMPENSATION: Specifies flexible schema handling EVOLUTION: Specifies automatic adaptation to schema changes TYPE EVOLUTION: Specifies automatic datatype adjustments |
| TBL Properties | Name | Specifies the property name | ||
| Value | Specifies the property value | |||
| SELECT | Available Tables and Views | Name | Specifies the name of the available table or view | |
| Type | Indicates the type of source object | |||
| Columns | Name | Specifies the column selected for the view | ||
| Alias | Specifies the alias assigned to the column. | |||
| Value | Specifies the expression used to derive the column value | |||
| FROM | Available Tables and Views | Name | Specifies the name of the available table or view | |
| Type | Indicates the type of the source object | |||
| From | Name | Specifies the source table or view used in the query | ||
| Alias | Specifies the alias assigned to the source object | |||
| Type | Indicates the type of the source object | |||
| WHERE | Where Clause | Where | Specifies the filtering condition applied to the data | |
| Group By Clause | Group By | Specifies the columns used to group the result set | ||
| Having Clause | Having | Specifies conditions applied to aggregated results | ||
| Order By Clause | Order | Specifies the sorting order of the result set | ||
| Tags List | Name | Specifies the tag name assigned to the view | ||
| Value | Specifies the value associated with the tag | |||
| User Defined SQL | User Defined SQL Statement | Specifies a custom SQL statement used to define the materialized view |
Provides a built-in SQL editor to create and manage custom SQL statements with the following options:
|
|
| SQL | Displays the SQL definition of the materialized view |
Provides a built-in editor to view and manage the SQL definition. The following options are available: Fold All / Unfold All – Specifies options to collapse or expand the SQL content Go to Line – Specifies navigation to a specific line in the script Validate – Specifies validation of the SQL syntax Read Only – Indicates whether the SQL editor is in read-only mode SQL – Indicates whether editing mode is enabled |
||
| Object Creation Order | Name | Specifies the object name in the creation sequence | ||
| Object Order | Specifies the order in which the view is created |
Warehouses
| Tab | Section | Property | Description | Additional Information |
|---|---|---|---|---|
| Properties | Name | Specifies the name of the warehouse | ||
| Use Replace Syntax | Indicates whether the warehouse should be replaced if it already exists | |||
| If Not Exists | Indicates whether the warehouse is created only if it does not already exist | |||
| Do Not Generate | Indicates whether the warehouse is excluded from script generation | |||
| Warehouse Options | With | Indicates whether the warehouse is created with specified object properties | ||
| Warehouse Size | Specifies the size of the virtual warehouse | |||
| Maximum Cluster Count | Specifies the maximum number of server clusters for the warehouse | |||
| Minimum Cluster Count | Specifies the minimum number of server clusters for the warehouse | |||
| Scaling Policy | Specifies the policy for automatically starting and shutting down clusters in a multi-cluster warehouse running in Auto-scale mode |
Standard: Indicates that the queuing is minimized by starting the warehouses Economy: Indicates that the warehouses are kept running fully to conserve credits |
||
| Auto Suspend | Specifies the time (in seconds) of inactivity after which a warehouse is automatically suspended | |||
| Auto Resume | Specifies whether a warehouse must automatically resume when a SQL statement is submitted | |||
| Initially Suspended | Specifies whether the warehouse is created in the suspended state | |||
| Resource Monitor | Specifies the resource monitor assigned to the warehouse | |||
| Warehouse Parameters | Maximum Concurrency Level | Specifies the maximum concurrency level for SQL statements executed by a warehouse cluster | ||
| Statement Queued Timeout In Seconds | Specifies the time (in seconds) that a SQL statement stays in a queue on the warehouse | |||
| Statement Timeout In Seconds | Specifies the time (in seconds) after which a running SQL statement is canceled by the system | |||
| Tags List | Name | Specifies the name of the tag | ||
| Value | Specifies the value of the available tag |
To view the common object properties that are supported in Snowflake , refer to Common Object Properties.
RE Parameters
The following sections explain the reverse engineering options for Snowflake .
Overview
| Parameter | Description | Additional Information |
|---|---|---|
| Reverse engineer source | Specifies the source used for reverse engineering |
Database: Indicates that the model is reverse engineered from a database Script File: Indicates that the model is reverse engineered from a script file |
| Type | Specifies the type of model to be created | Provides an option to choose the type of model between Physical or Logical/Physical |
| Database | Specifies the database selected for reverse engineering | |
| Version | Specifies the version of the selected database | |
| Script file | Specifies the script file's location | This option is available when Script File is selected. Select Browse and select a script file from your directory. |
Connection
| Parameter | Description | Additional Information |
|---|---|---|
| Database | Specifies the database for establishing the connection | |
| Version | Specifies the database version | |
| Authentication | Specifies the authentication method used for connection | Database Authentication: Specifies the authentication type for the database connection. |
| Username | Specifies the username for authentication | |
| Password | Specifies the password for authentication | |
| Connection Type | Specifies the type of connection used to connect to the database | JDBC: Specifies connection using Java Database Connectivity |
| Server Name | Specifies the database server host name | |
| Port | Specifies the port number used for the connection | |
| Database | Specifies the database name used during connection | |
| Warehouse | Specifies the warehouse used for processing queries | |
| Role | Specifies the Snowflake role used for the connection | |
| Authentication URL | Specifies the authentication URL used for connection | |
| Pass Code In Password | Specifies whether the MFA passcode is included in the password | Select this checkbox to append the MFA passcode to the password entered in the Password field. |
| MFA Passcode | Specifies the MFA passcode used for authentication | Enter the 6-digit MFA passcode separately from the Password field. |
Note: For Snowflake accounts with MFA enabled, MFA token caching must be enabled at the account level. Cached MFA tokens are valid for up to 4 hours. Reverse engineering operations that exceed this period may require re-authentication and can fail after the token expires.
Schemas
| Parameter | Description | Additional Information |
|---|---|---|
| System Objects | Indicates whether system-defined schemas are included | |
| Available Schemas | Displays the available schemas | |
| Selected Schemas | Displays the selected schemas |
Tables
| Parameter | Description | Additional Information |
|---|---|---|
| System Objects | Indicates whether system tables are included | |
| Available Tables | Displays the list of available tables | |
| Selected Tables | Displays the tables selected for reverse engineering |
Views
| Parameter | Description | Additional Information |
|---|---|---|
| Available Views | Displays the list of available views | |
| Selected Views | Displays the views selected for reverse engineering |
Options
| Parameter | Description | Additional Information |
|---|---|---|
| Options | Specifies the objects to be reverse engineered according to the selected option set. You can edit this list. |
FE Parameters
The following sections explain the forward engineering options for Snowflake .
Option Selection
| Parameter | Description | Additional Information |
|---|---|---|
| Object Type | Specifies the type of objects selected for forward engineering | |
| Properties | Specifies the properties associated with the selected object type |
Owner Override
| Parameter | Description | Additional Information |
|---|---|---|
| Object Name | Specifies the name of the object for which the owner is overridden | |
| Owner Override | Specifies the owner assigned to the selected object during schema generation |
Object Filter
| Parameter | Description | Additional Information |
|---|---|---|
| Object Filter | Specifies the objects selected for schema generation | |
| Select All | Indicates selection of all available objects | |
| Deselect All | Indicates removal of selection from all objects | |
| Invert Selection | Indicates reversal of the current selection | |
| Change display mode | Indicates switching between different object display views | |
| Full Screen | Indicates expansion of the object selection panel to full screen |
Preview
| Parameter | Description | Additional Information |
|---|---|---|
| Text | Displays the generated SQL or script preview. |
Commit to Git: Commits the FE script to a Git repository. Save: Saves the generated schema. Find: Searches within the generated schema. Print: Prints the generated schema. Copy: Copies the selected text in the schema. Replace: Finds and replaces text in the generated schema. Full Screen: Expands the preview window. |
Connection
| Database | Specifies the database for establishing the connection | |
| Version | Specifies the database version | |
| Authentication | Specifies the authentication method used for connection | Database Authentication: Specifies the authentication type for the database connection. |
| Username | Specifies the username for authentication | |
| Password | Specifies the password for authentication | |
| Connection Type | Specifies the type of connection used to connect to the database | JDBC: Specifies connection using Java Database Connectivity |
| Server Name | Specifies the database server host name | |
| Port | Specifies the port number used for the connection | |
| Database | Specifies the database name used during connection | |
| Warehouse | Specifies the warehouse used for processing queries | |
| Role | Specifies the Snowflake role used for the connection | |
| Authentication URL | Specifies the authentication URL used for connection | |
| Pass Code In Password | Specifies whether the MFA passcode is included in the password | Select this checkbox to append the MFA passcode to the password entered in the Password field. |
| MFA Passcode | Specifies the MFA passcode used for authentication | Enter the 6-digit MFA passcode separately from the Password field. |