Skip to main content

Search tables

GET https://api.rollstack.com/public/v1/connections/{type}/{id}/tables

The tables and views of a Snowflake, Databricks or BigQuery connection whose full name, database.schema.table (project.dataset.table on BigQuery), holds any word of query, in any case, at most 50, read with the user's access to the connection, as its default user when one is set. The first search of a connection reads its whole catalog, which can take a while on a large warehouse. On BigQuery it reads the billing project's tables, and another project's only when query names that project, by its ID or as the start of a name such as other-project.dataset. Search by the name the user gives and confirm the table with the user, then add it to a report with addReportDatasheets by its connection, database, schema and table, and pass the datasheet id on sendReportMessage: the slides agent queries it in the warehouse with SQL over all its rows. listConnections gives the connection's type and id.

Requires the connections:read scope.

Operation ID: searchTables.

Path parameters

  • type (string, required): The type of connection, as type in listConnections: the Snowflake, Databricks or BigQuery data warehouse. One of Snowflake, Databricks, BigQuery.
  • id (string, required): Unique identifier for the connection, from listConnections, which also returns its type.

Query parameters

  • query (string): Words to search for in names, separated by spaces: a dashboard, table, model or spreadsheet is returned when its name contains any of them, case-insensitively, a table's full name with its database and schema. If omitted, results aren't filtered by name. At most 50 results are returned either way. Example: revenue.

Response 200

Success

application/json: array of object

  • database (string, required): The database the table is in, its Unity Catalog catalog on Databricks and its Google Cloud project on BigQuery. Pass it as database to addReportDatasheets.
  • schema (string, required): The schema the table is in, its dataset on BigQuery. Pass it as schema to addReportDatasheets.
  • table (string, required): The table's name. Pass it as table to addReportDatasheets.
  • type (string, required): Whether it is a table, a view or a Databricks metric_view. All three can be added to a report. One of table, view, metric_view.