Connectors
A connector reads data that lives outside VAIF Studio, such as another database, a warehouse, a spreadsheet or a business app, so you can browse it in the console and query it from the API. Connect one under Integrations > Connectors.
- Read-only. A connector never writes to the service it reads.
- Nothing is installed in your VAIF database. VAIF Studio reads the service from its own servers and shows the result.
- Credentials are encrypted when you save them and are never shown again. When you edit a connector, leave a secret blank to keep the saved one. If you change where a connector points, such as its host or account, enter the secret again.
- Limits: at most 500 rows per request, and a request that takes longer than 15 seconds is stopped.
Your plan sets how many connectors a project can have; see Plans.
Available connectors
Section titled “Available connectors”| Connector | Reads |
|---|---|
| PostgreSQL | Read tables in another PostgreSQL database |
| MySQL / MariaDB | Read tables in a MySQL or MariaDB database |
| MongoDB | Read collections in your own MongoDB or Atlas cluster |
| Snowflake | Query a Snowflake warehouse with read-only SQL |
| BigQuery | List datasets and run read-only GoogleSQL |
| ClickHouse | Run read-only SQL on ClickHouse |
| Google Sheets | Read a spreadsheet's tabs and ranges as rows |
| Airtable | Read Airtable bases, tables and records |
| Notion | Read Notion databases and their pages |
| HubSpot | Read CRM contacts, companies, deals and tickets |
| Stripe | Read customers, charges, invoices and subscriptions |
| Firebase | Read Firebase Auth users and Firestore documents |
| AWS S3 | List buckets and objects |
| AWS Cognito | Read users and groups in a Cognito user pool |
| Logflare | List sources and read Logflare Endpoint results |
Who can do what
Section titled “Who can do what”| Action | Project role |
|---|---|
| See connectors and browse their tables | Viewer |
Run SQL (sql tables) or a pipeline (aggregate) |
Developer |
| Connect, edit, test or remove a connector | Admin |
Connecting
Section titled “Connecting”- Create a credential that can only read. Each connector’s page shows how.
- Choose Connect on the connector and fill in its settings.
- VAIF Studio tests the connection when you save. A connector whose test fails is still saved, marked Connection failing with the reason, so you can fix a setting without starting over.
| Method | Path | Project role |
|---|---|---|
| GET | /database/wrappers/available |
None |
| GET | /database/wrappers/project/{projectId} |
Viewer |
| POST | /database/wrappers/project/{projectId}/install |
Admin |
| PATCH | /database/wrappers/project/{projectId}/{wrapperId} |
Admin |
| DELETE | /database/wrappers/project/{projectId}/{wrapperId} |
Admin |
| POST | /database/connector/{projectId}/test |
Admin |
| GET | /database/connector/{projectId}/tables?wrapperId= |
Viewer |
| POST | /database/connector/{projectId}/query |
Viewer; Developer for sql and aggregate |
These routes take a console access token, not a project API key; see Access tokens. A query takes wrapperId (the connector’s id, shown in each connector page’s example), table, filters and limit (1 to 500). When there are more rows, the answer has hasMore: true and, for services that page by cursor, a nextCursor to pass back in the table’s cursor filter.