Skip to content

connection.md

Latest commit

 

History

History
83 lines (58 loc) · 1.79 KB

connection.md

File metadata and controls

83 lines (58 loc) · 1.79 KB

Connection

Connection files define database connections and schemas for the repository. These are required to import fact and dimension datasets into your repository.

Each connection file should define a single database connection and its schema. If you need to use additional schemas for the same database, each must be defined in a separate connection file. If a dataset uses a query instead of tables, the database and schema do not need to be specified in the connection file.

Sample connection file:

unique_name: Connection - TPCDS
label: Connection - TPCDS
object_type: connection
as_connection: Snowflake
database: tutorial_data
schema: tpcds

Entitity Relationships

classDiagram
    class Connection{
      String unique_name
      String label
      const object_type
      String as_connection
      String database
      String schema
    }
Loading

Connection Properties

unique_name

  • Type: string
  • Required: Y

A unique name for the database and the schema. This must be unique across all repositories and subrepositories.

object_type

  • Type: const
  • Required: Y

The type of object defined by this file. For connections, this value must be connection.

label

  • Type: string
  • Required: Y

The name of the database connection as it appears in the consumption tool. This value does not need to be unique.

as_connection

  • Type: string
  • Required: Y

The name of the database connection itself, excluding the schema.

database

  • Type: string
  • Required: N

The source database is required when used in the table datasets, but it is not necessary for query datasets.

schema

  • Type: string
  • Required: N

The source schema is required when used in the table datasets, but it is not necessary for query datasets.