Skip to content

Update Tables Documentation and General Introduction #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion api-reference/v2/general/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,30 @@ The Glide APIv2 is a RESTful API that allows you to programmatically interact wi

<Warning>This API is currently in a public beta state. Feedback is welcome. However, please be aware that **breaking changes are expected**!</Warning>

## Understanding Tables in Glide

Glide uses different types of tables to store and organize data within your applications. The main types of tables include:

### Big Tables
Big Tables are Glide's native database solution, designed for handling large datasets efficiently. They offer:
- High performance for large-scale data operations
- Direct API access through this v2 API
- Advanced querying capabilities
- Built-in data type validation
- Optimized for programmatic access

### Other Table Types
While not accessible through this API, Glide also supports:
- Google Sheets tables
- Excel tables
- Airtable connections
- CSV imports
- Custom data source integrations

<Note>
This v2 API exclusively works with Big Tables, making it the ideal choice when you need to programmatically manage large datasets or require high-performance data operations.
</Note>

## Functionality

This version of the Glide API **only accesses Big Table data sources**. An attempt to use this API with any other data source will return an error.
Expand All @@ -22,4 +46,4 @@ This Glide API v2 differs from previous versions in that it:
- Is the most performant way to programatically interact with Big Tables
- Is capable of ingesting much larger data sets through the use of [stashing](/api-reference/v2/stashing/introduction)
- Does not require application scoping (i.e., no `appId` is required)
- Only operates on Big Tables data sources
- Only operates on Big Tables data sources
17 changes: 17 additions & 0 deletions api-reference/v2/tables/get-tables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,21 @@ openapi: get /tables

Get a list of all Big Tables associated with the team of the authenticated user.

## Understanding Tables in Glide

Tables in Glide are the fundamental way to store, organize, and manage your application's data. They function similar to spreadsheets, with rows and columns that define your data structure. Each table consists of:

- A schema that defines the structure and data types of your columns
- Rows of data that conform to the schema
- A unique identifier for each row

Big Tables, which this endpoint specifically deals with, are Glide's most powerful and scalable data storage solution. They're designed for:

- Handling large datasets efficiently
- Supporting complex data types and relationships
- Enabling high-performance data operations
- Supporting bulk data operations through [stashing](/api-reference/v2/stashing/introduction)

Big Tables differ from other table types in Glide (such as Google Sheets or Airtable integrations) by being native to the Glide platform and optimized for performance at scale. They're the recommended choice when building data-intensive applications or when you need programmatic access to your data through the API.

<Warning>This endpoint only retrieves **Big Table** tables. No other table types will be included in the response, even though they are part of your Glide team.</Warning>
6 changes: 4 additions & 2 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@
"api-reference/v2/general/introduction",
"api-reference/v2/general/authentication",
"api-reference/v2/general/errors",
"api-reference/v2/general/limits"
"api-reference/v2/general/limits",
"api-reference/v2/general/introduction"
]
},
{
Expand All @@ -42,7 +43,8 @@
"api-reference/v2/tables/post-table-rows",
"api-reference/v2/tables/put-tables",
"api-reference/v2/tables/patch-table-row",
"api-reference/v2/tables/delete-table-row"
"api-reference/v2/tables/delete-table-row",
"api-reference/v2/tables/get-tables"
]
},
{
Expand Down