Actions13
Overview
The node interacts with the Budibase DB Public API, enabling users to manage database tables and their rows within a Budibase application. Specifically, the "Update Table" operation allows updating an existing table's metadata and schema. This is useful when you need to modify the structure of a table, such as changing its name, adjusting the primary display column used in relationships, or updating the table schema definition.
Common scenarios include:
- Renaming a table to better reflect its contents.
- Changing which column is used as the primary display for relationships.
- Modifying the schema to add, remove, or change columns and their data types.
Example: You have a "Customers" table but want to rename it to "Clients" and update the schema to include a new "email" field. Using this node operation, you can send the updated table name and schema JSON to Budibase to apply these changes.
Properties
| Name | Meaning |
|---|---|
| Table ID | The unique identifier of the table to update. |
| Table Name | The new name for the table. |
| Primary Display | The name of the column that should be used in relationship tags when relating to this table. |
| Table Schema | The JSON object defining the table schema, specifying column names and their data types (e.g., string, number). |
Output
The node outputs JSON data representing the response from the Budibase API after attempting to update the table. This typically includes confirmation of the updated table details such as its ID, name, primary display column, and schema. There is no binary output involved.
Dependencies
- Requires an API key credential for authenticating with the Budibase DB Public API.
- The node expects the base URL of the Budibase instance to be configured via credentials.
- No other external dependencies are required.
Troubleshooting
- Invalid Table ID: If the provided Table ID does not exist or is incorrect, the API will return an error indicating the table was not found. Verify the Table ID before running the node.
- Malformed Table Schema JSON: Ensure the Table Schema property contains valid JSON matching the expected schema format. Invalid JSON or incorrect schema definitions will cause the request to fail.
- Authentication Errors: Missing or invalid API credentials will result in authentication failures. Confirm that the API key and domain are correctly set in the node credentials.
- Permission Issues: The API user must have sufficient permissions to update tables. Lack of permissions will cause authorization errors.
Links and References
- Budibase Documentation
- Budibase API Reference (for detailed API endpoints and schema definitions)