vectorTableSource

You can use vectorTableSource to build layers and widgets using tables in your data warehouse that contain:

• Vector data:

  • points,

  • lines,

  • polygons

  • etc...

Usage

import {vectorTableSource} from '@carto/api-client';

const data = vectorTableSource({
  accessToken: 'XXX',
  connectionName: 'carto_dw',
  tableName: 'carto-demo-data.demo_tables.chicago_crime_sample'
});

Options

type VectorTableSourceOptions = {
  tableName: string;
  columns?: string[];
  spatialDataColumn?: string;
  aggregationExp?: string;
  filters?: Filters;
  filtersLogicalOperator?: 'and' | 'or'; 
};

• tableName: The fully qualified name (FQN) of the table you want to retrieve from your data warehouse. For example, for a BigQuery connection, carto-demo-data.demo_tables.chicago_crime_sample would be a valid table name.

• columns (optional): The list of columns to retrieve from the table specified in tableName . Useful to increase performance and optimize query costs in tables with a large number of columns. By default, all columns will be retrieved.

• spatialDataColumn (optional): The name of the column that contains the geospatial information (geometries/geographies) that will be used for visualization and etc. By default, CARTO assumes this column is named geom.

• aggregationExp (optional): An optional SQL expression that will define how this source will group identical geometries found in the spatialDataColumn. By default this property is empty and all rows will be returned. However, when this property is defined:

  • This source will return only one data point for each set of duplicated geometries

  • Each set of duplicated geometries will be aggregated using the aggregation expression defined. For example, if you have a dataset with multiple identical polygons or points and a "income" column and youraggregationExp is AVG(income) , only one polygon or point will be returned, with an income column that equals the average income of all the polygons or points identical to that one.

• filters (optional): A valid CARTO Filters object, used to perform server-side filtering of this data source with column-based filters.

• filtersLogicalOperator (optional): Indicates whether filters are applied following an AND logic or an OR logic.

Response

The response of vectorTableSource is a promise that can be resolved and used in layers and widgets.

Connection compatibility

Connection Data Warehouse	Compatible
BigQuery	✅
Snowflake	✅
Redshift	✅
Databricks	✅
PostgreSQL	✅
CARTO Data Warehouse	✅

Layer compatibility

vectorTableSource is compatible with the following layers from the @deck.gl/carto module:

• VectorTileLayer

Widget model compatibility

vectorTableSource is compatible with the following widget models:

• getFormula

• getCategories

• getHistogram

• getRange

• getScatter

• getTimeSeries

• getTable