### Install BaseQL Airtable Connector
Source: https://github.com/baseql/baseql-docs/blob/main/pages/install/airtable.mdx
Steps to install and configure the Airtable data source in BaseQL. This involves signing up for BaseQL, adding Airtable as a data source, and creating a Personal Access Token with specific scopes for read and write access.
```bash
1. Signup/Login to [BaseQL app](https://app.baseql.com/)
2. Click `+Add New Data Source` > `Airtable`
3. Create a [`Personal Access Token`](https://airtable.com/create/tokens)
- Allow `data.records:read` & `schema.bases:read` scopes
- If using mutations, allow `data.records:write` scope too
4. Click `Fetch Bases`
5. Select your desired base from the list
```
--------------------------------
### JavaScript Examples for Webflow Integration
Source: https://github.com/baseql/baseql-docs/blob/main/pages/integrations/webflow.mdx
This section provides links to more JavaScript examples relevant to Webflow integration. These examples showcase various functionalities and patterns used when connecting Baseql with Webflow.
```javascript
console.log('See more JS examples at: /examples/javascript');
```
--------------------------------
### Axios Request to BaseQL
Source: https://github.com/baseql/baseql-docs/blob/main/pages/examples/javascript.mdx
Shows how to send a POST request to the BaseQL API using the Axios library. This example configures the request with the API endpoint, method, authorization header, and a GraphQL query within the data payload. It then logs the received data.
```jsx
const axios = require("axios");
axios({
url: 'https://api.baseql.com/airtable/graphql/appuzDcQEvfnkzXjD',
method: 'post',
headers: { 'Authorization': 'Bearer SECRET_TOKEN' },
data: {
query: `{
people {
name
}
}`
}
}).then((result) => {
console.log(result.data)
});
```
--------------------------------
### Fetch API Request to BaseQL
Source: https://github.com/baseql/baseql-docs/blob/main/pages/examples/javascript.mdx
Demonstrates how to make a POST request to the BaseQL API using the Javascript Fetch API. It includes setting headers for content type, acceptance, and authorization, along with sending a GraphQL query in the request body. The response is parsed as JSON.
```jsx
fetch('https://api.baseql.com/airtable/graphql/appuzDcQEvfnkzXjD', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer SECRET_TOKEN',
},
body: JSON.stringify({query: "{ people: { name } }"})
})
.then(r => r.json())
.then(data => console.log('data returned:', data));
```
--------------------------------
### GraphQL Features: Aliases, Fragments, Operation Names, and Variables
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/querying.mdx
Shows how to utilize advanced GraphQL features within BaseQL queries. This example demonstrates using aliases for multiple queries on the same data, fragments for reusable query structures, operation names for identifying queries, and variables for dynamic query parameters.
```graphql
query Veganism($country: [String] = ["🇺🇸USA"]) {
vegan: people(vegan: true, country: $country) { ...peopleFields },
nonVegan: people(vegan: false, country: $country) { ...peopleFields }
}
fragment peopleFields on people {
name
vegan
country
friends {
name
vegan
country
}
}
```
--------------------------------
### Querying with Multiple Parameters and Filtering
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/view.mdx
This example shows how to query records from a specific Airtable view ('Custom Sort') while also applying pagination (`_page_size`) and filtering (`_filter`). It retrieves the 'name' and 'vegan' fields for people who are vegan, with a page size of 2.
```graphql
{
people(
_view: "Custom Sort",
_page_size: 2,
_filter: {vegan: true}
) {
name
vegan
}
}
```
--------------------------------
### Sort by Multiple Columns
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/sorting.mdx
This example illustrates sorting by multiple columns, with the first column ('vegan') sorted in descending order and the second ('offspring') in ascending order.
```graphql
{
people(_order_by: [
{vegan: "desc"},
"offspring"
]) {
name,
vegan,
offspring
}
}
```
--------------------------------
### Sort by Single Column
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/sorting.mdx
This example demonstrates how to sort query results by a single column in ascending order.
```graphql
{
people(_order_by: "name") {
name
}
}
```
--------------------------------
### cURL POST Request to Baseql API
Source: https://github.com/baseql/baseql-docs/blob/main/pages/examples/curl.mdx
This snippet shows how to send a POST request to the Baseql GraphQL endpoint using cURL. It includes setting the Accept and Content-Type headers to application/json, providing an Authorization token, and sending a JSON payload containing a GraphQL query.
```bash
curl \
-X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer SECRET_TOKEN" \
--data '{ "query": "{ people { name } }" }' \
https://api.baseql.com/airtable/graphql/appuzDcQEvfnkzXjD
```
--------------------------------
### Example Query for Filtering and Sorting Related Records
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/related-record-arguments.mdx
Demonstrates how to filter friends by vegan status, sort them by name, and paginate the results. This query fetches people named 'Rob' and then retrieves their vegan friends, ordered by name, with pagination applied.
```graphql
{
people(name: "Rob") {
name
friends(
_filter: { vegan: true }
_order_by: { name: "asc" }
_page_size: 2
_page: 1
) {
name
vegan
city {
name
}
}
}
}
```
--------------------------------
### Update Airtable Personal Access Token
Source: https://github.com/baseql/baseql-docs/blob/main/pages/install/airtable.mdx
Instructions for updating your Airtable Personal Access Token within BaseQL if it has been changed or revoked. The process mirrors the initial setup.
```bash
Follow the exact same process [as described above](#installation) to update your personal access token.
```
--------------------------------
### Pagination Use Case
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/aggregation.mdx
Utilize aggregations to get total counts for implementing pagination UI. This allows you to display total items and manage page navigation.
```graphql
{
_aggregates {
people {
count
}
}
people(_page_size: 3, _page: 1) {
name
}
}
```
--------------------------------
### Sort by Column Direction (Descending)
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/sorting.mdx
This example shows how to specify the sorting direction for a single column, in this case, descending order.
```graphql
{
people(_order_by: {name: "desc"}) {
name
}
}
```
--------------------------------
### GraphiQL Explorer Integration
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/explorer.mdx
This snippet shows the import and usage of the SupportedBy component within the BaseQL Explorer's documentation section. It highlights the integration of external components for enhanced UI features.
```javascript
import SupportedBy from '../../components/supported-by';
// ... inside a React component
```
--------------------------------
### Nextra Theme Docs Bleed Component
Source: https://github.com/baseql/baseql-docs/blob/main/pages/playground/gsheets.mdx
Demonstrates the usage of the `Bleed` component from `nextra-theme-docs`, likely used for full-width content display.
```javascript
import { Bleed } from 'nextra-theme-docs'
// ... component usage ...
{/* Content inside Bleed */}
```
--------------------------------
### Notion.so Integration Status
Source: https://github.com/baseql/baseql-docs/blob/main/pages/install/notion.mdx
This section provides an update on the Notion.so integration for Baseql. It indicates that the feature is under development and provides a link to a waiting list for launch notifications.
```javascript
import { Callout, Steps } from 'nextra/components'
# Notion.so
We're actively working on adding support for Notion! In the meantime, you can join our waiting list to be notified when the Notion GraphQL integration launches. [Sign up here](https://baseql.com/notion-graphql-integration.html).
```
--------------------------------
### BaseQL Live Playground
Source: https://github.com/baseql/baseql-docs/blob/main/pages/playground/airtable.mdx
An interactive iframe embedding the BaseQL live playground. This allows users to directly query a showcase base and experience BaseQL features. It requires no specific dependencies beyond a web browser.
```html
```
--------------------------------
### Next.js with SWR and BaseQL GraphQL Fetcher
Source: https://github.com/baseql/baseql-docs/blob/main/pages/examples/nextjs.mdx
This snippet shows how to set up a fetcher function using `graphql-request` to interact with a BaseQL GraphQL API within a Next.js application using SWR for data fetching. It defines a `fetcher` that sends GraphQL queries to a specified endpoint and demonstrates its usage within a React component.
```jsx
import { request } from 'graphql-request'
const fetcher = query =>
request('https://api.baseql.com/airtable/graphql/appuzDcQEvfnkzXjD', query)
function App () {
const { data, error } = useSWR(`{
people(vegan: true) {
name
}
}`,
fetcher
)
// ...
```
--------------------------------
### Base Info Modal - Metadata Refresh
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/explorer.mdx
This section describes the 'Base Info' modal, which allows users to view metadata update times and manually trigger a refresh. It includes a visual representation of the modal.
```html
```
--------------------------------
### Nextra Theme Docs Bleed Component
Source: https://github.com/baseql/baseql-docs/blob/main/pages/integrations/retool.mdx
Demonstrates the usage of the Bleed component from 'nextra-theme-docs' for creating visually distinct content sections. It includes an embedded YouTube video.
```javascript
import { Bleed } from 'nextra-theme-docs'
// ... component usage ...
```
--------------------------------
### Showcase Google Sheet Embed
Source: https://github.com/baseql/baseql-docs/blob/main/pages/playground/gsheets.mdx
Embeds a Google Sheet that serves as the data source for the BaseQL playground. This allows users to see the data being queried.
```html
```
--------------------------------
### GraphQL Query with Multiple Arguments
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/multiple.mdx
Demonstrates how to construct a GraphQL query in BaseQL that utilizes multiple arguments for filtering, ordering, and pagination. This includes specifying a filter condition, sorting order, page size, and the desired page number.
```graphql
{
people(
_filter: {vegan: {_eq: false}},
_order_by: [{name: "desc"}],
_page_size: 2,
_page: 2
) {
name
}
}
```
--------------------------------
### Airtable Showcase Base
Source: https://github.com/baseql/baseql-docs/blob/main/pages/playground/airtable.mdx
An embedded iframe displaying the BaseQL showcase base hosted on Airtable. This provides a direct view of the data structure and content used in the playground. It requires no specific dependencies beyond a web browser.
```html
```
--------------------------------
### Querying Data Types
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/querying.mdx
Demonstrates querying various data types available in BaseQL, showcasing how different Airtable fields are represented. Note that Google Sheets always returns data as strings.
```graphql
{
strangerThings {
checkBox
rating
multiSelect
email
currency
attachments
}
}
```
--------------------------------
### BaseQL Live Playground with Google Sheets
Source: https://github.com/baseql/baseql-docs/blob/main/pages/playground/gsheets.mdx
Embeds an iframe to interact with the BaseQL live playground, which queries a Google Sheet. This allows users to directly test BaseQL features.
```html
```
--------------------------------
### Vue.js Integration Status
Source: https://github.com/baseql/baseql-docs/blob/main/pages/examples/vue.mdx
Indicates that Vue.js integration with Baseql is currently under development and will be available soon.
```markdown
import { Callout, Steps } from 'nextra/components'
# Vue.js
Coming soon...
```
--------------------------------
### Paginate Results with _page_size and _page
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/pagination.mdx
Demonstrates how to fetch paginated results from a GraphQL API using BaseQL. It utilizes the `_page_size` parameter to control the number of items per page and the `_page` parameter to specify the desired page number. This is a common pattern for handling large datasets efficiently.
```graphql
{
people(
_page_size: 3,
_page: 1
) {
name
}
}
```
--------------------------------
### Supported Filtering Operators
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/filtering.mdx
Lists the available operators for advanced filtering in BaseQL, categorized into Comparison and Logical operators.
```APIDOC
Supported Operators:
#### Comparison
- Equality: `_eq`, `_ne`
- Greater than or less: `_gt`, `_gte`, `_lt`, `_lte`
- List-based: `_in`, `_nin`
#### Logical
- Group: `_and`, `_or`
```
--------------------------------
### Gatsby.js Integration Status
Source: https://github.com/baseql/baseql-docs/blob/main/pages/examples/gatsby.mdx
This section indicates that Gatsby.js integration with Baseql is currently under development and will be available soon.
```markdown
import { Callout, Steps } from 'nextra/components'
# Gatsby.js
Coming soon...
```
--------------------------------
### Caching Status
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/caching.mdx
Indicates that caching features are currently under development and not yet available.
```markdown
# Caching
Coming soon...
```
--------------------------------
### Search Feature Status
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/search.mdx
Indicates that the Search feature is currently under development and will be available soon. It uses Nextra components for display.
```javascript
import { Callout, Steps } from 'nextra/components'
# Search
Coming soon...
```
--------------------------------
### Google Sheets Data Requirements
Source: https://github.com/baseql/baseql-docs/blob/main/pages/install/gsheets.mdx
Specifies the formatting rules for Google Sheets to ensure compatibility with BaseQL. Data must begin at cell A1, and the first row must contain headers.
```APIDOC
GoogleSheets:
DataFormat:
- StartCell: A1
Description: Data must begin in the top-leftmost cell (A1).
- HeaderRow: Required
Description: The first row of the sheet must contain column headers.
```
--------------------------------
### Using Secret Token for Authentication
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/settings.mdx
Protect your BaseQL endpoints by enabling authentication with a secret token. This token should be included in the `Authorization` HTTP header as a `Bearer` token.
```bash
curl -H "Authorization: Bearer YOUR_SECRET_TOKEN" https://your-baseql-endpoint.com/graphql
```
```javascript
fetch('https://your-baseql-endpoint.com/graphql', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer YOUR_SECRET_TOKEN'
},
body: JSON.stringify({
query: '{
hello
}'
})
});
```
--------------------------------
### Advanced Filtering with DSL
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/filtering.mdx
Introduces the advanced filtering DSL, which supports logical and comparison operators similar to MongoDB and Hasura. This allows for complex filtering conditions.
```graphql
{
people(_filter: {
_and: [
{
_or: [
{vegan: {_eq: true}}
{city: {_nin: ["Los Angeles", "Monterrey"]}}
]
},
{
netWorth: {_gte: 5000}
}
]
}) {
name
}
}
```
--------------------------------
### BaseQL Integration with Airtable and Google Sheets
Source: https://github.com/baseql/baseql-docs/blob/main/pages/index.mdx
This section describes BaseQL's capability to provide a GraphQL endpoint for Airtable and Google Sheets. It also includes a callout for users to request support for other services.
```javascript
import { Callout, Steps } from 'nextra/components'
```
```markdown
# BaseQL
**BaseQL** provides a GraphQL endpoint for [Airtable](/install/airtable) and [Google Sheets](/install/gsheets)
Need to connect another service?
Please let us know!
```
--------------------------------
### Basic Filtering by Field Values
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/filtering.mdx
Demonstrates basic filtering of data by specifying field values. This is useful for simple queries where you need to match exact values for fields like country or boolean flags.
```graphql
{
people(
country: "🇺🇸USA",
vegan: true
) {
name
}
}
```
--------------------------------
### Querying Relationships and Nested Values
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/querying.mdx
Illustrates how to query nested data and relationships in BaseQL. This allows for traversing through connected records, such as friends of people, to an arbitrary depth.
```graphql
{
people(name: "ben") {
name
friends {
name
friends {
name
}
}
}
}
```
--------------------------------
### Enabling Mutations
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/settings.mdx
Mutations are disabled by default in BaseQL for security reasons. It is recommended to enable secret token protection when using mutations.
```APIDOC
EnableMutations: true
# Recommended: Enable secret token protection when using mutations.
```
--------------------------------
### Insert Record Mutation
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/mutations.mdx
Demonstrates how to insert a new record into the 'people' table. You can retrieve the generated ID and other fields immediately after insertion. Dependencies include the GraphQL client.
```graphql
mutation {
insert_people(
name: "John",
vegan: true,
friends: ["recXYZ789"]
) {
id, name, vegan,
friends { name }
}
}
```
```graphql
{
insert_people [{
id: "recABC123",
name: "John",
vegan: true,
friends: [
{ name: "Peter" }
]
}]
}
```
--------------------------------
### Analytics Dashboard Use Case
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/aggregation.mdx
Display summary statistics across multiple tables using aggregations. This is ideal for building comprehensive analytics dashboards.
```graphql
{
_aggregates {
allPeople: people {
count
}
veganPeople: people(vegan: true) {
count
}
cities {
count
}
}
}
```
--------------------------------
### Root Aggregations
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/aggregation.mdx
Access '_aggregates' at the query root to count records across entire tables. This is useful for dashboard metrics and overview statistics.
```graphql
{
_aggregates {
people {
count
}
cities {
count
}
}
}
```
--------------------------------
### BaseQL Arguments for Related Records
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/related-record-arguments.mdx
Lists the available arguments for filtering, sorting, and pagination on nested relation fields in BaseQL. These arguments provide granular control over how related data is fetched.
```APIDOC
BaseQL Related Record Arguments:
_filter: Filter related records using the same syntax as root-level filters.
- Type: Object
- Description: Specifies conditions for filtering related records.
_order_by: Sort related records by one or more fields.
- Type: Object
- Description: Defines the sorting criteria (e.g., { field_name: "asc" | "desc" }).
_page_size: Number of related records to return per page.
- Type: Integer
- Description: Controls the number of items in each page of results.
_page: Which page of related records to return.
- Type: Integer
- Description: Specifies the page number to retrieve.
```
--------------------------------
### Querying a Specific Airtable View
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/view.mdx
This snippet demonstrates how to query records from a specific view named 'Custom Sort' in your Airtable base using BaseQL. It shows the basic syntax for selecting fields from the 'people' table.
```graphql
{
people(_view: "Custom Sort") {
name
}
}
```
--------------------------------
### Deleting a Base
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/settings.mdx
This action completely removes your base from the BaseQL system. Be aware that deleting the base will also delete the associated GraphQL endpoint.
```APIDOC
DELETE /bases/{baseId}
Description: Deletes a specific base and its associated GraphQL endpoint.
Parameters:
- baseId (path, required): The unique identifier of the base to delete.
Returns:
- 200 OK: If the base was successfully deleted.
- 404 Not Found: If the base with the specified ID does not exist.
Example:
DELETE /bases/base_12345
```
--------------------------------
### Embedded YouTube Video
Source: https://github.com/baseql/baseql-docs/blob/main/pages/integrations/retool.mdx
An HTML iframe element used to embed a YouTube video. This is commonly used in documentation or web pages to display video content.
```html
```
--------------------------------
### Filtering List-based Values
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/filtering.mdx
Shows how to filter data based on list-based fields such as multi-selects, lookups, and relationships. By default, these filters operate with an AND logic.
```graphql
{
people(
friends: ["daniel", "peter"]
) {
name
friends {
name
}
}
}
```
--------------------------------
### Filtering Aggregations with Direct Field Arguments
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/aggregation.mdx
Filter aggregations using direct field arguments, similar to regular queries. This provides a straightforward way to narrow down the count.
```graphql
{
_aggregates {
people(vegan: true) {
count
}
}
}
```
--------------------------------
### Relation Aggregations
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/aggregation.mdx
Access '_aggregates' on individual records to count related records. This enables rich data insights and relationship analysis for each parent record.
```graphql
{
people(name: "ben") {
name
_aggregates {
friends {
count
}
}
}
}
```
--------------------------------
### Multiple Aggregations Use Case
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/aggregation.mdx
Combine multiple aggregations in a single query using aliases. This allows for efficient retrieval of various counts in one request.
```graphql
{
_aggregates {
allPeople: people {
count
}
veganPeople: people(vegan: true) {
count
}
wealthyVegans: people(_filter: {
_and: [
{ vegan: { _eq: true } },
{ netWorth: { _gte: 10000 } }
]
}) {
count
}
}
}
```
--------------------------------
### Update Record Mutation
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/mutations.mdx
Shows how to update an existing record in the 'people' table by providing its unique 'id'. You can modify attributes like 'vegan' and 'friends'. Dependencies include the GraphQL client.
```graphql
mutation {
update_people(
id: "recABC123", # required
vegan: false,
friends: [
"recXYZ789", "recDEF456"
]
) {
id, name, vegan,
friends { name }
}
}
```
```graphql
{
insert_people [{
id: "recABC123",
name: "John",
vegan: false,
friends: [
{ name: "Peter" },
{ name: "Rodrick" }
]
}]
}
```
--------------------------------
### Filtering Aggregations with Complex Filters (_filter)
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/aggregation.mdx
Use the advanced filtering DSL with '_filter' for complex conditions when aggregating data. This allows for sophisticated filtering logic.
```graphql
{
_aggregates {
people(_filter: {
_and: [
{ vegan: { _eq: true } },
{ netWorth: { _gte: 5000 } }
]
}) {
count
}
}
}
```
--------------------------------
### Filtering Relation Aggregations
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/aggregation.mdx
Apply filters to relation-level aggregations to count related records that meet specific criteria. This enhances relationship analysis.
```graphql
{
people {
name
_aggregates {
friends(_filter: { vegan: { _eq: true } }) {
count
}
}
}
}
```
--------------------------------
### Delete Record Mutation
Source: https://github.com/baseql/baseql-docs/blob/main/pages/usage/mutations.mdx
Illustrates how to delete a record from the 'people' table using its 'id'. This operation requires only the 'id' of the record to be removed. Dependencies include the GraphQL client.
```graphql
mutation {
delete_people(
id: "recABC123", # required
) { }
}
```
```graphql
{
insert_people [{
id: "recABC123"
}]
}
```
=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.
Notion.so
```
--------------------------------
### Nextra Theme Docs Bleed Component
Source: https://github.com/baseql/baseql-docs/blob/main/pages/integrations/retool.mdx
Demonstrates the usage of the Bleed component from 'nextra-theme-docs' for creating visually distinct content sections. It includes an embedded YouTube video.
```javascript
import { Bleed } from 'nextra-theme-docs'
// ... component usage ...
[Airtable](/install/airtable) and 
[Google Sheets](/install/gsheets)