Search tables
- OpenAPI 3.1.0 document: https://api.rollstack.com/public/v1/openapi.json
- The whole reference in Markdown: https://docs.rollstack.com/llms-full.txt
- An index of the reference: https://docs.rollstack.com/llms.txt
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, astypeinlistConnections: theSnowflake,DatabricksorBigQuerydata warehouse. One ofSnowflake,Databricks,BigQuery.id(string, required): Unique identifier for the connection, fromlistConnections, which also returns itstype.
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 asdatabasetoaddReportDatasheets.schema(string, required): The schema the table is in, its dataset on BigQuery. Pass it asschematoaddReportDatasheets.table(string, required): The table's name. Pass it astabletoaddReportDatasheets.type(string, required): Whether it is atable, aviewor a Databricksmetric_view. All three can be added to a report. One oftable,view,metric_view.