Overwrite Table

Replaces the schema and/or data of a Big Table

Overwrite an existing Big Table by clearing all rows and adding new data.

Updating the Schema

You can optionally update the table schema at the same time by providing a new schema in the JSON request body. If you do not provide a schema, the existing schema will be used.

When using a CSV or TSV request body, you cannot pass a schema. If you need to update the schema, use the onSchemaError=updateSchema query parameter, or stash the CSV/TSV data and pass a JSON request body referencing the stash ID.

Examples

Clear table data

To clear all rows from a table, send a PUT request with an empty array in the rows field:

{
    "rows": []
}

Reset table data

If you want to reset a table’s data with a small number of rows, you can do so by providing the data inline in the rows field (being sure that row object structure matches the table schema):

[
    {
        "fullName": "Alex Bard",
        "ageInYears": 30,
        "hiredOn": "2021-07-03"
    }
]

However, this is only appropriate for relatively small initial datasets (around a few hundred rows or less, depending on schema complexity). If you need to work with a larger dataset you should utilize stashing.

Reset table data from Stash

Stashing is our process for handling the upload of large datasets. Break down your dataset into smaller, more manageable, pieces and upload them to a single stash ID.

Then, to reset a table’s data from the stash, use the $stashID reference in the rows field instead of providing the data inline:

{
    "rows": { "$stashID": "20240215-job32" }
}

Batch update table rows

This endpoint can be combined with the Get Rows endpoint and stashing to fetch the current table data, modify it, and then overwrite the table with the updated data:

1. Call the Get Rows endpoint to fetch the current table data. Pass a reasonably high limit query parameter because you want to fetch all rows in as few requests as possible.
2. Modify the data as desired, and then stash the modified rows using the Stash Data endpoint.
3. If a continuation was returned in step 1, repeat steps 1-3, passing the continuation query parameter to Get Rows until all rows have been fetched, modified, and stashed.
4. Finally, call this endpoint with same stash ID used in step 2. This will overwrite the table with the updated data:

{
    "rows": { "$stashID": "20240215-job32" }
}

Risk of Data Loss

We strongly recommend you use the If-Match header to ensure the table is not modified between steps 1 and 4. See the Data Versioning guide for more information.

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

if-match

string

ETag of the current table version. If provided, the request will fail if the table has been updated since this version.

Path Parameters

tableID

string

required

ID of the table, e.g., 2a1bad8b-cf7c-44437-b8c1-e3782df6

Query Parameters

onSchemaError

enum<string>

The action to take when the passed data does not match the table schema:

• abort: Abort the entire operation and return an error.
• dropColumns: Ignore the data that caused the error, and do not import those columns in the affected rows.
• updateSchema: Update the schema as needed to add any missing columns or widen the data types of existing columns, and then import the data from them.

Available options:

abort,

dropColumns,

updateSchema

Body

• object
• object[]

rows

required

A collection of row objects conforming to the schema of the table where keys are the column IDs and values are the column values:

[
	{
		"fullName": "Alex Bard",
		"invoiceDate": "2024-07-29T14:04:15.561Z",
		"totalAmount": 34.50,
		"amountPaid": 0
	},
	{
		"fullName": "Alicia Hines",
		"invoiceDate": "2023-06-15T10:30:00.000Z",
		"totalAmount": 50.75,
		"amountPaid": 20
	}
]

Show child attributes

schema

object

The schema of the table as a collection of column definitions.

Show child attributes

Response

200 - application/json

data

object

required

Show child attributes