Budibase DB icon

Budibase DB

Interact with Budibase DB Public API

Overview

The node provides integration with the Budibase DB Public API, enabling users to interact programmatically with Budibase database resources. Specifically, the "Search Tables" operation allows users to search for tables within a Budibase app whose names start with a specified string. This is useful when managing or querying multiple tables dynamically, such as listing tables matching a prefix or filtering tables by partial names.

Practical examples include:

  • Automatically retrieving all tables starting with "user_" to process user-related data.
  • Searching for tables with a common naming pattern before performing batch operations.

Properties

Name Meaning
Table Name Starts With A string used to filter tables whose names begin with this value during the search.

Output

The node outputs JSON data representing the search results from the Budibase API. The json output field contains an array or object describing the tables that match the search criteria (i.e., tables whose names start with the provided string). The exact structure depends on the Budibase API response but typically includes table metadata such as table IDs, names, and schemas.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Budibase DB Public API.
  • The base URL for API requests is configured dynamically from the user's credentials (the domain of the Budibase instance).
  • No additional external dependencies are required beyond standard HTTP request capabilities.

Troubleshooting

  • Empty Results: If no tables are returned, verify that the "Table Name Starts With" property matches existing table name prefixes exactly.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to access the Budibase app.
  • Invalid Domain or URL: Confirm that the domain credential is correctly set to the Budibase instance URL.
  • Malformed Input: The "Table Name Starts With" should be a simple string; complex patterns or unsupported characters may cause errors.

Common error messages will likely relate to authentication failures, invalid URLs, or empty responses due to no matching tables.

Links and References

Discussion