Secoda Docs
Get Started
  • Getting Started with Secoda
    • Secoda as an Admin
      • Deployment options
      • Sign in options
      • Settings
      • Connect your data
        • Define Service Accounts
        • Choose which schemas to extract
      • Customize the workspace
      • Populate Questions with FAQs
      • Invite your teammates
        • Joining & Navigating between Multiple Workspaces
      • Onboard new users
        • Onboarding email templates
        • Onboarding Homepage template
        • Training session guide
      • User engagement and adoption
        • Tips & Tricks to share with new users
    • Secoda as an Editor
    • Secoda as a Viewer
      • Introduction guide
      • Requesting changes in Secoda
  • Best practices
    • Setting up your workspace
    • Integrating Secoda into existing workflows
    • Documentation best practices
    • Glossary best practices
    • Data governance
    • Data quality
    • Clean up your data
    • Tool migrations using Secoda
    • Slack <> Questions workflow
    • Defining resources workflow
    • Streamline data access: Private and public teams workflow
    • Exposing Secoda to external clients
  • Resource Management
    • Editing Properties
      • AI Description Editor
      • Bulk Editing
      • Propagation
      • Templates
    • Resource Sidesheet
    • Assigning Owners
    • Custom Properties
    • Tags
      • Custom Tags
      • PII Identifier
      • Verified Identifier
    • Import and Export Resources
    • Related Resources
  • User Management
    • Roles
    • Teams
    • Groups
  • Integrations
    • Integration Settings
    • Data Warehouses
      • BigQuery
        • BigQuery Metadata Extracted
      • Databricks
        • Databricks Metadata Extracted
      • Redshift
        • Redshift Metadata Extracted
      • Snowflake
        • Snowflake Metadata Extracted
        • Snowflake Costs
        • Snowflake Native App
      • Apache Hive
        • Apache Hive Metadata Extracted
      • Azure Synapse
        • Azure Synapse Metadata Extracted
      • MotherDuck
        • MotherDuck Metadata Extracted
      • ClickHouse
        • ClickHouse Metadata Extracted
    • Databases
      • Druid
        • Druid Metadata Extracted
      • MySQL
        • MySQL Metadata Extracted
      • Microsoft SQL Server
        • Page
        • Microsoft SQL Server Metadata Extracted
      • Oracle
        • Oracle Metadata Extracted
      • Salesforce
        • Salesforce Metadata Extracted
      • Postgres
        • Postgres Metadata Extracted
      • MongoDB
        • MongoDB Metadata Extracted
      • Azure Cosmos DB
        • Azure Cosmos DB Metadata Extracted
      • SingleStore
        • SingleStore Metadata Extracted
      • DynamoDB
        • DynamoDB Metadata Extracted
    • Data Visualization Tools
      • Amplitude
        • Amplitude Metadata Extracted
      • Looker
        • Looker Metadata Extracted
      • Looker Studio
        • Looker Studio Metadata Extracted
      • Metabase
        • Metabase Metadata Extracted
      • Mixpanel
        • Mixpanel Metadata Extracted
      • Mode
        • Mode Metadata Extracted
      • Power BI
        • Power BI Metadata Extracted
      • QuickSight
        • QuickSight Metadata Extracted
      • Retool
        • Retool Metadata Extracted
      • Redash
        • Redash Metadata Extracted
      • Sigma
        • Sigma Metadata Extracted
      • Tableau
        • Tableau Metadata Extracted
      • ThoughtSpot
        • ThoughtSpot Metadata Extracted
      • Cluvio
        • Cluvio Metadata Extracted
      • Hashboard
        • Hashboard Metadata Extracted
      • Lightdash
        • Lightdash Metadata Extracted
      • Preset
        • Preset Metadata Extracted
      • Superset
        • Superset Metadata Extracted
      • SQL Server Reporting Services
        • SQL Server Reporting Services Metadata Extracted
      • Hex
        • Hex Metadata Extracted
      • Omni
        • Omni Metadata Extracted
    • Data Pipeline Tools
      • Census
        • Census Metadata Extracted
      • Stitch
        • Stitch Metadata Extracted
      • Airflow
        • Airflow Metadata Extracted
      • Dagster
        • Dagster Metadata Extracted
      • Fivetran
        • Fivetran Metadata Extracted
      • Glue
        • Glue Metadata Extracted
      • Hightouch
        • Hightouch Metadata Extracted
      • Apache Kafka
        • Apache Kafka Metadata Extracted
      • Confluent Cloud
        • Confluent Cloud Metadata Extracted
      • Polytomic
        • Polytomic Metadata Extracted
      • Matillion
        • Matillion Metadata Extracted
      • Airbyte
        • Airbyte Extracted Metadata
      • Informatica
        • Informatica Metadata Extracted
      • Azure Data Factory
        • Azure Data Factory Metadata Extracted
    • Data Transformation Tools
      • dbt
        • dbt Cloud
          • dbt Cloud Metadata Extracted
        • dbt Core
          • dbt Core Metadata Extracted
      • Coalesce
        • Coalesce Metadata Extracted
    • Data Quality Tools
      • Cyera
      • Dataplex
        • Dataplex Metadata Extracted
      • Great Expectations
        • Great Expectations Metadata Extracted
      • Monte Carlo
        • Monte Carlo Metadata Extracted
      • Soda
        • Soda Metadata Extracted
    • Data Lakes
      • Google Cloud Storage
        • GCS Metadata Extracted
      • AWS S3
        • S3 Metadata Extracted
    • Query Engines
      • Trino
        • Trino Metadata Extracted
    • Custom Integrations
      • File Upload
        • CSV File Format
        • JSONL File Format
        • Maintain your Resources
      • Marketplace
        • Secoda SDK
        • Upload and Connect your Marketplace Integration
        • Publish the Integration
        • Example Integrations
      • Secoda Fields Explained
    • Security
      • Connecting via Reverse SSH Tunnel
      • Connecting via SSH Tunnel
      • Connecting via VPC Peering
      • Connecting via AWS Cross Account Role
      • Connecting via AWS PrivateLink
        • Snowflake via AWS PrivateLink
        • AWS Service via AWS PrivateLink
      • Recommendations to Improve SSH Tunnel Concurrency on SSH Bastion
    • Push Metadata to Source
  • Extensions
    • Chrome
    • Confluence
      • Confluence Metadata Extracted
      • Confluence best practices
    • Git
    • GitHub
    • Jira
      • Jira Metadata Extracted
    • Linear
    • Microsoft Teams
    • PagerDuty
    • Slack
      • Slack user guide
  • Features
    • Access Requests
    • Activity Log
    • Analytics
    • Announcements
    • Audit Log
    • Automations
      • Automations Use Cases
    • Archive
    • Bookmarks
    • Catalog
    • Collections
    • Column Profiling
    • Data Previews
    • Data Quality Score
    • Documents
      • Comments
      • Embeddings
    • Filters
    • Glossary
    • Homepage
    • Inbox
    • Lineage
      • Manual Lineage
    • Metrics
    • Monitors
      • Monitoring Use Cases
    • Notifications
    • Policies
    • Popularity
    • Publishing
    • Queries
      • Query Blocks
        • Chart Blocks
      • Extracted Queries
    • Questions
    • Search
    • Secoda AI
      • Secoda AI User Guide
      • Secoda AI Use Cases
      • Secoda AI Security FAQs
      • Secoda MCP Server
    • Sharing
    • Views
  • Enterprise
    • SAML
      • Okta SAML
      • OneLogin SAML
      • Microsoft Azure AD SAML
      • Google SAML
      • SCIM
      • SAML Attributes
    • Self-Hosted
      • Additional Resources
        • Additional Environment Variables
          • PowerBI OAuth Application (on-premise)
          • Google OAuth Application (on-premise)
          • Github Application (on-premise)
          • OpenAI API Key Creation (on-premise)
          • AWS Bucket with Access Keys (on-premise)
        • TLS/SSL (Docker compose)
        • Automatic Updates (Docker compose)
        • Backups (Docker compose)
        • Outbound Connections
      • Self-Hosted Changelog
    • SIEM
      • Google Chronicle
  • API
    • Get Started
    • Authentication
    • Example Workflows
    • API Reference
      • Getting Started
      • Helpful Information
      • Audit Logs
      • Charts
      • Collections
      • Columns
      • Custom Properties
      • Dashboards
      • Databases
      • Documents
      • Events
      • Groups
      • Integrations
      • Lineage
      • Monitors
      • Resources
      • Schemas
      • Tables
      • Tags
      • Teams
      • Users
      • Questions
      • Queries
      • Getting Started
      • Helpful Information
      • Audit Logs
      • Charts
      • Collections
      • Columns
      • Custom Properties
      • Dashboards
      • Databases
      • Documents
      • Events
      • Groups
      • Integrations
      • Lineage
      • Monitors
      • Resources
      • Schemas
      • Tables
      • Tags
      • Teams
      • Users
      • Questions
      • Queries
  • FAQ
  • Policies
    • Terms of Use
    • Secoda AI Terms
    • Master Subscription Agreement
    • Privacy Policy
    • Security Policy
    • Accessibility Statement
    • Data Processing Agreement
    • Subprocessors
    • Service Level Agreement
    • Bug Bounty Program
  • System Status
  • Changelog
Powered by GitBook
On this page
  • Base Resource Fields
  • Lineage Fields
  • LineageID Fields

Was this helpful?

  1. Integrations
  2. Custom Integrations

Secoda Fields Explained

This page explains all the fields that are used to add metadata to the resources in Secoda.

Last updated 11 months ago

Was this helpful?

The fields below are referenced in the , the , and in the .

Base Resource Fields

The following fields apply to all the in Secoda.

Field Name
Data Type
Description
Required
Example

entity_type

Enum database, schema, table, column, dashboard_group, dashboard, chart

The type of resource.

"table"

databuilder_id

String

A unique and unchanging ID created for the resource.

"secoda.snowflake.customers"

parent_databuilder_id

String

A unique and unchanging ID referencing the parent for the resource.

"secoda.snowflake.orders"

title

String

The title or name for the resource.

"customer"

description

String

The description for the resource.

"This table reflects all the customers in the workspace"

definition

String

The mark down documentation for the resource.

"<h2>This is my documentation</h2>"

external_updated_at

String (datetime format)

The last time the resource was updated in the source.

"2000-10-31T01:30:00.000-05:00"

native_type

String

The type of the resource as it's referred to in the source.

"view"

For specific resource types, additional fields are available or required, as listed below.

Column Specific Fields

Field Name
Data Type
Description
Required (for Columns)
Example

sort_order

Integer

The order in which the columns should show up.

4

type

String

The datatype of the column.

"integer"

is_pk

Boolean

Defines whether the column is a primary key.

"true"

parent_databuild_id

String

A unique and unchanging ID referencing the parent for the resource. For a column, the parent is either another column or a table.

"snowflake.orders.table"

Table Specific Fields

Field Name
Data Type
Description
Required (for Tables)
Example

schema

String

The schema from which the table is extracted.

"sales"

database

String

The database from which the table is extracted.

"sales_db"

Dashboard Specific Fields

Field Name
Data Type
Description
Required (for Dashboards)
Example

group

String

The group that the dashboard is extracted from.

"analytics"

Chart Specific Fields

Field Name
Data Type
Description
Required (for Charts)
Example

product

String

The name of the source.

"tableau"

parent_databuilder_id

String

A unique and unchanging ID referencing the parent for the resource. For a chart, the parent is a dashboard.

"tableau.analytics.dashboard"

Lineage Fields

The lineage fields can be used to build a connection between any two resources in Secoda.

Each Lineage object should have a to_identifier to represent a target resource, and a from_identifier to represent a source resource. One or both of these resources must be an internal resource (a part of the custom integration that is being built).

The to_identifier and from_identifier accept a LineageID object, which is made up of a type, as well as several fields unique to each type. The type and relevant fields are broken down below.

Field Name
Data Type
Description
Required
Example

from_identifier

Object

A LineageID object identifying the type of lineage, and source resource.

"from_identifier": { "type": "external_column", "cluster": "data_warehouse_cluster", "database": "marketing_db", "schema": "public", "table": "campaign_data", "column": "click_through_rate" }

to_identifier

Object

A LineageID object identifying the type of lineage, and target resource. This field does not accept tables_from_query as a type.

"to_identifier": { "type": "internal_resource", "databuilder_id": "internal.dashboard.654" }

LineageID Fields

The LineageID object will always consist of a type field, along with several other fields depending on the type.

Field Name
Data Type
Description
Required
Example

type

Enum -internal_resource -external_table -external_column -tables_from_query

The type of resource in the context of lineage.

"internal_resource"

Internal Resource Fields

If the source or target resource is internal to the integration, the type of the LineageID object should be internal_resource, and the following field is required in addition to type.

Field Name
Data Type
Description
Required
Example

databuilder_id

String

A unique and unchanging ID referencing the internal resource in Secoda.

"internal.dashboard.123"

External Table Fields

If the source or target resource is a table external to the integration, the type of the LineageID object should be external_table, and the following fields are required in addition to type.

Field Name
Data Type
Description
Required
Example

cluster

String

The name of the cluster that the external table belongs to in Secoda.

"sales"

database

String

The name of the database that the external table belongs to in Secoda.

"sales_db"

schema

String

The name of the schema that the external table belongs to in Secoda.

"staging"

table

String

The name of the external table.

"customers"

External Column Fields

If the source or target resource is a column external to the integration, the type of the LineageID object should be external_column. In addition to type, all of the fields from the External Table type are required, along with a field for column.

Field Name
Data Type
Description
Required
Example

column

String

The name of the external column.

"customer_id"

Tables from Query Fields

For the source resource (the LineageID object in the from_identifier field), the type can also be tables_from_query. This type requires an SQL query that will be processed to determine what the source resources are.

Field Name
Data Type
Description
Required
Example

sql

String

An SQL query used to determine lineage. The SQL query must return resources that exist in Secoda.

"SELECT * FROM public.users INNER JOIN public.orders ON users.id = orders.user_id"

JSONL file
SDK Documentation
API docs
Resources