Budibase DB icon

Budibase DB

Interact with Budibase DB Public API

Actions13

Overview

The node interacts with the Budibase DB Public API, specifically allowing users to create a new table within a Budibase application. This operation is useful when you want to programmatically define and add new data tables to your Budibase app without manually configuring them through the Budibase UI.

Typical use cases include:

  • Automating the setup of database schemas during app deployment.
  • Dynamically creating tables based on external inputs or workflows.
  • Integrating Budibase with other systems that require custom table creation as part of their process.

For example, you might use this node to create a "Customers" table with columns like "name" (string) and "count" (number), which can then be used in subsequent operations such as adding rows or querying data.

Properties

Name Meaning
Table Name The name of the table to be created in the Budibase database.
Primary Display The name of the column that should be used in relationship tags when relating to this table.
Table Schema A JSON object defining the schema of the table, specifying column names and their data types.

Example of Table Schema property value:

{
  "name": "string",
  "count": "number"
}

Output

The node outputs JSON data representing the response from the Budibase API after attempting to create the table. This typically includes details about the newly created table such as its ID, name, schema, and metadata confirming successful creation.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Budibase DB Public API.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The base URL for the API is dynamically set from the credential's domain configuration.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Malformed JSON in the Table Schema property may result in request errors.
    • Using a table name that already exists could lead to conflicts or errors from the API.

  • Error Messages:

    • Authentication errors usually indicate invalid or expired API keys; verify and update credentials.
    • Validation errors from the API often point to incorrect schema definitions; ensure the JSON schema is valid and matches expected formats.
    • Network or connectivity issues may cause timeouts or unreachable host errors; check network settings and API availability.

Links and References

Discussion