DataWarehouse

A data warehouse destination in Segment that stores raw customer data for analytics, business intelligence, and data science workloads.

Properties

• id (string): Unique identifier for the data warehouse.
• name (string): Name of the data warehouse.
• slug (string): URL-friendly identifier for the data warehouse.
• description (string): Description of the data warehouse and its purpose.
• type (string): Warehouse type (redshift, bigquery, snowflake, postgres, databricks).
• enabled (boolean): Whether the warehouse sync is enabled.
• workspace (string): Workspace ID this data warehouse belongs to.
• source ([[Source]]): Source connected to this data warehouse.
• settings (object): Warehouse-specific connection settings.
• credentials (object): Authentication credentials (encrypted).
• host (string): Database host address.
• port (number): Database port number.
• database (string): Database name.
• schema (string): Database schema name.
• username (string): Database username.
• connectionString (string): Full connection string (encrypted).
• syncSchedule (object): Scheduled sync configuration.
• syncFrequency (string): Sync frequency (hourly, daily, custom).
• lastSyncedAt (string): ISO 8601 timestamp of last successful sync.
• nextSyncAt (string): ISO 8601 timestamp of next scheduled sync.
• tables (object[]): Data warehouse tables and their schemas.
• collections (object[]): Collections synced to data warehouse.
• metadata (object): Data warehouse metadata and custom properties.
• createdAt (string): ISO 8601 timestamp when data warehouse was created.
• updatedAt (string): ISO 8601 timestamp when data warehouse was last updated.
• createdBy (string): User ID who created the data warehouse.
• status (string): Data warehouse status (active, syncing, error, paused).
• syncMetrics (object): Sync performance and volume metrics.
• storageSize (number): Total storage size in bytes.
• rowCount (number): Total number of rows synced.
• compression (boolean): Whether data compression is enabled.
• encryption (boolean): Whether data encryption is enabled.

Actions

create

Create a new data warehouse connection.

Input: [[DataWarehouse]]
Output: [[DataWarehouse]]

update

Update data warehouse configuration.

Input: [[DataWarehouse]]
Output: [[DataWarehouse]]

delete

Delete a data warehouse connection.

Input: [[DataWarehouse]]
Output: [[DataWarehouse]]

enable

Enable data warehouse syncing.

Input: [[DataWarehouse]]
Output: [[DataWarehouse]]

disable

Disable data warehouse syncing.

Input: [[DataWarehouse]]
Output: [[DataWarehouse]]

test

Test data warehouse connection.

Input: [[DataWarehouse]]
Output: [[TestResult]]

sync

Trigger manual sync to data warehouse.

Input: [[DataWarehouse]]
Output: [[SyncResult]]

getSchema

Retrieve data warehouse schema and tables.

Input: [[DataWarehouse]]
Output: [[WarehouseSchema]]

updateSchedule

Update sync schedule configuration.

Input: [[SyncSchedule]]
Output: [[DataWarehouse]]

getMetrics

Get sync and storage metrics.

Input: [[MetricsRequest]]
Output: [[WarehouseMetrics]]

getLogs

Retrieve sync execution logs.

Input: [[LogRequest]]
Output: [[SyncLogs]]

pause

Pause data warehouse syncing.

Input: [[DataWarehouse]]
Output: [[DataWarehouse]]

resume

Resume data warehouse syncing.

Input: [[DataWarehouse]]
Output: [[DataWarehouse]]

Events

• created: Triggered when a data warehouse is created.
• updated: Triggered when data warehouse configuration is updated.
• deleted: Triggered when a data warehouse is deleted.
• enabled: Triggered when data warehouse sync is enabled.
• disabled: Triggered when data warehouse sync is disabled.
• tested: Triggered when data warehouse connection is tested.
• syncStarted: Triggered when sync begins.
• syncCompleted: Triggered when sync completes successfully.
• syncFailed: Triggered when sync fails.
• paused: Triggered when data warehouse is paused.
• resumed: Triggered when data warehouse is resumed.
• error: Triggered when data warehouse encounters an error.