Budibase DB icon

Budibase DB

Interact with Budibase DB Public API

Overview

The Budibase DB node allows interaction with the Budibase Database Public API. It supports various operations on database tables and rows, such as creating, updating, deleting, retrieving, and searching data within tables of a Budibase app. This node is useful for automating workflows that involve managing Budibase app data without manual intervention.

A common use case is to retrieve a specific table's metadata or contents ("Get Table" operation) to integrate Budibase data into other systems or to perform further processing in an automated workflow. For example, you might use this node to fetch a table's structure before dynamically generating reports or syncing data with external databases.

Properties

Name Meaning
Table ID The unique identifier of the table to operate on. Required for operations including "Get Table".

Output

The node outputs JSON data representing the response from the Budibase API for the requested operation. For the "Get Table" operation, the output JSON typically contains the metadata and schema details of the specified table, such as its columns, types, and configuration.

No binary data output is indicated by the source code.

Dependencies

  • Requires an active connection to the Budibase API via an API key credential.
  • The node expects the base URL of the Budibase instance to be provided through credentials.
  • Proper permissions on the Budibase app and tables are necessary to perform read operations.

Troubleshooting

  • Invalid or missing Table ID: If the Table ID property is empty or incorrect, the API call will fail. Ensure the Table ID corresponds to an existing table in your Budibase app.
  • Authentication errors: Missing or invalid API credentials will cause authentication failures. Verify that the API key and domain URL are correctly configured in the node credentials.
  • Network issues: Connectivity problems to the Budibase server can result in timeouts or unreachable errors. Check network access and firewall settings.
  • API changes: If the Budibase API changes, some operations may break. Keep the node updated with the latest API specifications.

Links and References

Discussion