Databricks

Quest Data Modeler (QDM) supports Databricks as a target database. This topic summarizes the supported datatypes, objects, object properties, and reverse and forward engineering options.

Supported Data types

Numeric

String

Date and Time

Other

  • BIGINT

  • BOOLEAN

  • DECIMAL

  • DECIMAL()

  • DECIMAL(,)

  • DOUBLE

  • FLOAT

  • INT

  • CHAR

  • CHAR()

  • STRING

  • VARCHAR

  • VARCHAR()

  • DATE

  • INTERVAL

  • TIMESTAMP

  • TIMESTAMP_NTZ

  • Null

Supported Objects

The following list summarizes the objects supported in Databricks:

Note: You can use the Ctrl+Z and Ctrl+Y keyboard shortcuts to undo and redo changes in any property field.

Catalogs

Tab Section Property Description
General Properties Name Specifies the name of the catalog
Physical Name Specifies the physical name of the catalog in the database
Generate Indicates whether the catalog is included in script generation
If Not Exists Indicates whether the catalog is created only if it does not already exist
Options Location Specifies the storage location for the catalog
Using Share Info Specifies the sharing configuration for the catalog
Tags Specifies the tags assigned to the catalog

CTAS

Tab Section Property Description Additional Information
Properties Properties Name Specifies the name of the table created using CTAS  
Comments Specifies descriptive information for the table  
Physical Name Specifies the physical name used in the database  
Catalog Specifies the catalog in which the table is created  
Database Specifies the database (schema) in which the table is created  
Generate Indicates whether the table is included in script generation  
General Options Location Specifies the storage location for the table  
Table Properties Specifies key-value properties for the table  
Tags Specifies tags assigned to the table  
Using Specifies the storage format used for the table  
Options Specifies additional configuration options for table creation  
Version As Specifies the version used for time travel queries  
Timestamp As Specifies the timestamp used for time travel queries  
Storage Row Format Fields Terminated By Specifies the delimiter used to separate fields  
Fields Escaped By Specifies escape character used for special characters  
Collection Items Terminated By Specifies delimiter for collection elements.  
Map Keys Terminated By Specifies delimiter for map keys  
Lines Terminated By Specifies line delimiter  
Null Defined As Specifies representation of NULL values  
Serde and Storage Format Serde Handler Class Specifies the serializer/deserializer class  
Stored As Specifies the file format used for table storage

Options include Textfile, ORC, Parquet, Avro.
Input Format Specifies the input format class  
Output Format Specifies the output format class  
Stored By Specifies custom storage handler  
Serde Properties Specifies properties for the SerDe implementation  
SELECT Available Tables and Views Name Specifies the name of the source table or view  
    Type Indicates the type of source object  
  Columns Name Specifies the column selected for the query  
    Alias Specifies alias for the column  
    Value Specifies expression or transformation applied  
From Available Tables and Views Name Specifies the source table or view  
    Type Indicates the object type  
  From Name Specifies selected source object  
    Alias Specifies alias for the source object  
    Type Indicates the selected object type  
Where Where Clause Where Specifies filtering condition applied to rows  
  Group By Clause Group By Specifies columns used for grouping data  
  Having Clause Having Specifies filter condition on aggregated data  
  Order By Clause Order Specifies sorting order of results  
User Defined SQL User Defined SQL Statement   Specifies custom SQL used to define the table  
SQL     Displays generated SQL definition  
Style Optional Theme   Specifies the theme applied to the object

Classic Theme: Specifies standard visual styling.

DARK Theme: Specifies dark visual styling.

Default Theme: Specifies system default theme.
  Name Display Font Options Specifies font settings for object name  
   

Fill Options

 Specifies background styling  
    Outline Options Specifies border styling  
  Comments Display Font Options Specifies font settings for comments  
    Fill Options Specifies comment background styling  
    Outline Options Specifies comment border styling  
  Column Display Fonts Owned Column Specifies font for owned columns  
    Alternate Key (AK) Column Specifies font for alternate keys  
    Inversion Entry (IE) Specifies font for inversion entries  
    Expression Specifies font for expressions  
  Icon Image Specifies icon representation for the object  
    Icon Image Specifies the icon image used  

Databases

Tab Section Property Description
General Properties Name Specifies the name of the database
Physical Name Specifies the physical name used in the database
Generate Indicates whether the database is included in script generation
Catalog Specifies the catalog in which the database is created
If Not Exists Indicates whether the database is created only if it does not already exist
Database Options Location Specifies the storage location for the database
DB Properties Specifies key-value properties assigned to the database
Tags Specifies the tags assigned to the database
Owner Role Specifies the role assigned as the owner of the database
Owner User Specifies the user assigned as the owner of the database

Datatype Standards

Tab Section Property Description
Properties   Name Specifies the name of the datatype standard
    Is Active Indicates whether the datatype standard is active
Logical Defintion   Datatype Specifies the physical datatype mapped to the standard
    Domain Specifies the domain associated with the datatype standard
    Length Specifies the maximum length of the datatype
    Precision Specifies the numeric precision for the datatype
Maping   Name Specifies the name of the mapping
    From Specifies the source datatype or value
    To Specifies the target datatype or value
Definition     Specifies additional descriptive details for the datatype standard

Default Values

Tab Section Property Description
Properties   Name Specifies the name of the default value
    Physical Only Indicates whether the default value exists only in the physical model
General   Name Specifies the name of the default value entry
    Physical Name Specifies the name used for the default value in the database
    Value Specifies the default value assigned

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 Name Specifies the name of the constraint.  
    Validation Rule Specifies the rule used to validate domain values.  
    Use Inherited Constraint Indicates whether the constraint is inherited from the parent domain.  
  Default Use Inheritance Default Value Indicates whether the default value is inherited from the parent domain.  
    Name Specifies the name of the definition entry.  
Definition     Specifies the detailed description or business meaning of the domain. Use Expand icon which opens defintion editor. to open the Definition Editor to edit annotation descriptions. Select Save to apply changes or Cancel to discard them.

ER Diagrams

Tab Section Property Description Additional Properties
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 and vertical shadow offset.  
    Shadow Offset - Bottom Specifies the horizontal and 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 shown.  
    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  
    Display Column Null Option  
    Display Column SDI Option  
    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  
    Display Ungenerated Tables Indicates whether ungenerated objects are displayed.  
    Display Ungenerated Indexes  
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  
    Display View Column Null Option  
    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 Expand icon which opens defintion editor. to open the Definition Editor to edit annotation descriptions. Select Save to apply changes or Cancel to discard them.

Functions

Tab Section Property Description Additional Information
Properties   Name Specifies the name of the function.  
    Is Temporary    
    If Not Exists    
    Generate Indicates whether the function is included in script generation.  
    Use Replace Syntax Indicates whether CREATE OR REPLACE syntax is used.  
    Catalog Specifies the catalog that contains the function.  
    Database Specifies the database that contains the function.  
Function Options   Is Deterministic Indicates whether the function returns consistent results for the same input.  
    Language Specifies the programming language used in the function.  
    Return Data Type Specifies the datatype returned by the function.  
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 Expand icon which opens defintion editor. to open the Definition Editor to edit function descriptions. Select Save to apply changes or Cancel to discard them.
Sql     Displays the SQL definition for the file format.

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

Groups

Tab Section Property Description Additional Information
General   Name Specifies the name of the group  
    Physical Name Specifies the physical name of the group  
    Generate Indicates whether the group is included in script generation  
  Users User Specifies the users associated with the group  
    Checked Indicates whether the user is selected as part of the group  

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 domainSpecifies the naming standard format for physical column 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.

  • P (Prime) – Indicates the primary business term

  • M1 (Modifier 1) – Indicates the first descriptive modifier

  • M2 (Modifier 2) – Indicates the second descriptive modifier

  • C (Class) – Indicates the classification or type
    Definition Specifies the description or meaning of the glossary word.  
Definition     Specifies the detailed description or purpose of the naming standard. Use Expand icon which opens defintion editor. to open the Definition Editor to edit naming standard descriptions. Select Save to apply changes or Cancel to discard them.

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.  

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 Expand icon which opens defintion editor. to open the Definition Editor to edit subject area descriptions. Select Save to apply changes or Cancel to discard them.

Tables

Tab

Property

Description

Additional Information
  Physical Name Specifies the physical name of the table  
  Database Specifies the database to which the table belongs  
  If Not Exists Specifies that if the table already exists, no exception is thrown, and no action happens  
  Use Replace Syntax Specifies whether the REPLACE syntax is used Selecting this option replaces the syntax with the new DDL that is generated during Forward Engineering.
  Physical Only Specifies whether the table appears in a physical model only  
  Generate Specifies whether a DDL statement is generated for the table during forward engineering  
General Physical Name Specifies the physical name of the table  
Location

Specifies the directory path where the table data is stored

Specifies the path of an external table when a delta table is cloned

Entering a location makes the table an external table.

 
Table Properties Specifies a list of key-value pairs used to tag the table definition

For example, CREATE TABLE `default`.`test` (`c` INT) USING text TBLPROPERTIES ( 'transient_lastDdlTime' = '1586269021');

This creates a table with the following table properties: 'transient_lastDdlTime' = '1586269021'.

Tags

Specifies a list of tags used to search table

For example, ALTER TABLE catalog_162.tag_162.my_table12345 SET TAGS ('tag1' = 'val1', 'tag2' = 'val2', 'tag3' = 'val3');

This applies three metadata tags to the table my_table12345 located in the schema tag_162 of the catalog_162.
Using Specifies the file format for the table For example, TEXT.
Options Specifies the table options to optimize table behavior You can enter key-value pairs to define options for the table.
Version as Specifies the version of a Delta table This option is part of temporal specification and references a Delta table using its version.
Timestamp As Specifies a timestamp of a Delta table This option is part of temporal specification and references a Delta table at the specified point in time.
Like Table Specifies the table from which the table definition and metadata is copied  
Clone Table Specifies the source delta table that is cloned  
Clone Type Specifies the clone type

Shallow: Indicates that Databricks copies the source table definition and does not copy data

Deep: Indicates that Databricks makes a complete, independent copy of the source table
Storage Fields Terminated By Specifies a character that defines column separator For example, comma ' , '.
Fields Escaped By Specifies an escape mechanism  
Collection Items Terminated By Specifies a character that defines collection item separator For example, underscore ' _ '.
Map Keys Terminated By Specifies a character to define a map key separator For example, colon ' : '.
Lines Terminated By Specifies a row separator character For example, new line ' \n '.
Null Defined As Specifies a value for NULL For example, ' foonull'.
Serde Handler Class Specifies a fully qualified class of a custom SerDe

Default classes are available when Stored As is set to ORC, AVRO, or PARQUET.

This option is blank if native SerDe is used.
Stored As Specifies the file format for the table  
Input Format Specifies the input format for the table Default formats are available when Stored As is set to TEXTFILE, SEQUENCE FILE, ORC, PARQUET, AVRO, or RCFILE.
Output Format Specifies the output format of the table
Stored By Specifies a non-native table format using a storage handler For example, org.apache.hadoop.hive.hbase.HBaseStorageHandler
Serde Properties Specifies a list of key-value pairs used to define SerDe properties  
Bucketing and Partition Bucket Columns Specifies the columns based on which partitions on the table are converted into fixed buckets These columns are specified using the CLUSTERED BY clause in the Create Table statement. This clause is not supported by Delta Lake.
Bucket Sorted Columns Specifies the order in which data is stored in buckets This order is specified using the SORTED BY clause in the Create Table statement. This clause is not supported by Delta Lake.
Bucket Option Specifies the number of buckets into which each partition is divided  
Name Specifies the name of the partition  
Partition Specification Specifies the partition specification  
Location Specifies the location of the partition  
Partitions

Tab

Property

Description

Additional Information
  Name Specifies the name of the partition  
General Serde Handler Class Specifies a fully-qualified class of a custom SerDe  
Stored As Specifies the file format for the table  
Input Format Specifies the input format for the table Default input formats are available when Stored As is set to TEXTFILE, SEQUENCE FILE, ORC, PARQUET, AVRO, or RCFILE.
Output Format Specifies the output format of the table Default output formats are available when Stored As is set to TEXTFILE, SEQUENCE FILE, ORC, PARQUET, AVRO, or RCFILE.
  Serde Properties Specifies a list of key-value pairs used to define SerDe properties  
Columns

Tab

Property

Description

Additional Information
  Physical Name Specifies physical name of the column  
  Domain Parent Specifies the parent domain of the column  
  Physical Data Type Specifies the physical data type of the column  
  Physical Only Specifies whether the column is included in the physical model only  
  SDI Specifies whether the column contains Personally Identifiable Information (SDI)  
  Partition Specifies whether a partition is created on the table by the column  

 

Tags

 Specifies a list of tags used to search column

For example, ALTER TABLE catalog_162.tag_162.my_table12345 ALTER COLUMN address SET TAGS ('tag1' = 'add1', 'tag2' = 'add2', 'tag3' = 'add3');

This applies three metadata tags to the address column of the table my_table12345 in schema tag_162 of catalog_162.
  Comments Specifies comments about the column  
General Domain Parent Specifies the domain parent of the column  
Physical Name Specifies the physical name of the column  
Physical Data Type Specifies the physical data type of the column  
Null Option Specifies the null option for the selected column

Null: Indicates that null values are allowed

Not Null: Indicates that null values are not allowed
Databricks Bloom Filter Specifies whether the bloom filter index is created for the column  
Options Specifies a list of key value pairs as options  
Generated Always Expression Specifies the expression that determines the value of this column  
Physical Data Type Expression Specifies the physical data type expression of the column  
Indexes
Tab Section Property Description
Properties   Name Specifies the name of the index
    Type Specifies the type of index
    Is Unique Indicates whether the index enforces uniqueness
    Physical Only Indicates whether the index exists only in the physical model
    Constraint Option Specifies the constraint behavior associateIndicates whether the index is included in script generation. d with the index
    Generate Indicates whether the index is included in script generation
Members   Name Specifies the column or member included in the index

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

User Ids

Tab Section Property Description
Proprties   Name Indicates whether the index is included in script generation
    Physical Name Specifies the physical name of the user in the database
    Generate Indicates whether the user is included in script generation

Validation Rules

Tab Section Property Description
Properties   Name Specifies the name of the validation rule
    Type Specifies the type of validation rule
    Physical Only Indicates whether the validation rule exists only in the physical model
    Generate Indicates whether the validation rule is included in script generation

Views

Tab

Property

Description

Additional Information
  Name Specifies the name of the view  
  Database Specifies the database to which the view belongs  
  Temporary Specifies whether the scope of the view is temporary A view with the temporary scope is available in the current session.
  If Not Exists Specifies that if the table already exists, no exception is thrown, and no action happens  
  Global Specifies whether the view is global Databricks attaches GLOBAL TEMPORARY views to a preserved temporary database global_temp.
  Use Replace Syntax Specifies whether the REPLACE syntax is used for the view Selecting this option replaces the syntax with the new DDL that is generated during Forward Engineering.
  Generate Specifies whether a DDL statement is generated for the view during forward engineering  
General Table Properties Specifies a list of metadata key-value pairs  
Select Available Tables and Views Specifies a list of available tables and views Under Available Tables and Views, select the columns that you want to define as view column. Then, click .
Columns Specifies the columns selected from the available tables and views
Select Type Specifies the expression type to indicate whether duplicate rows are returned

All: Indicates that the statement returns all rows, including duplicate rows

Distinct: Indicates that the statement discards duplicate rows and returns only the remaining rows
Alias Specifies a temporary name given to a table, column, or expression present in a query based on the selected column  
Expression Specifies the expression for a selected column Available only when the selected column is a user-defined function expression
From Available Tables and Views Specifies a list of available tables and views Under Available Tables and Views, select the tables or views from which you want to select view columns. Then, click .
From Specifies the selected tables and views
Alias Specifies an alternate name for the selected table or view  
Where Where Specifies the boolean expression of the Where clause  
Group By Specifies the grouping expression that defines how the rows are grouped together  
Having Specifies the boolean expression of the Having clause  
Order Specifies the expression of the Order By clause  

To view the common object properties that are supported in Databricks, refer Common Object Properties.

RE Parameters

Following sections explain the reverse engineering options for Databricks.

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 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 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.

OAuth: Specifies that OAuth authentication is used for the Databricks connection
Username Specifies the username for authentication Available only when the Authentication is set to Database 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
Connection String

Specifies the connection string based on your JDBC instance in the following format:

jdbc:spark://<server-hostname>:443/default;transportMode=http;ssl=1;httpPath=<http-path>

  

Catalogs

Parameter Description Additional Information
Available Catalogs Specifies a list of available unity catalogs  
Selected Catalogs Specifies a list of selected unity catalogs for reverse engineering  

Databases

Parameter Description Additional Information
System Objects Specifies whether system databases are included under the Available Databases  
Available Databases Specifies a list of available databases  
Selected Databases Specifies a list of selected databases for reverse engineering  

Tables

Parameter Description Additional Information
Available Tables Specifies a list of available tables  
Selected Tables Specifies a list of selected tables for reverse engineering  

Views

Parameter Description Additional Information
Available Views Specifies a list of available view objects  
Selected Views Specifies a list of selected view objects 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

Following sections explain the forward engineering options for Databricks.

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: use this option to commit the FE script to a Git repository.

Save: Use this option to save the generated schema.

Find: Use this option to find through the generated schema.

Print: Use this option to print the generated schema.

Copy: Use this option to copy the selected text in the schema.

Replace: Use this option to find and replace text in the generated schema.

Full Screen: Use this option to expand the preview window.

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 Available only when the Authentication is set to Database 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
Connection String

Specifies the connection string based on your JDBC instance in the following format:

jdbc:spark://<server-hostname>:443/default;transportMode=http;ssl=1;httpPath=<http-path>