Nocodb Self Host icon

Nocodb Self Host

Nocodb Self Host operations

Overview

This node connects to a self-hosted NocoDB instance and retrieves all rows from a specified table within a given base/project. It is useful for scenarios where you want to fetch entire datasets from NocoDB for further processing, analysis, or integration with other systems in your n8n workflows.

Practical examples include:

  • Exporting all records from a NocoDB table to another database or service.
  • Synchronizing data between NocoDB and external applications.
  • Automating reporting by fetching the latest data from NocoDB tables.

Properties

Name Meaning
NocoDB Token Your NocoDB API token (either xc-token or xc-auth) used for authenticating requests.
NocoDB Base URL The URL of your self-hosted NocoDB instance (e.g., https://your-nocodb-instance.com).
Base ID The identifier of your NocoDB base/project (e.g., pnnh9o17by6p172).
Table ID The identifier of the specific table within the base from which to retrieve all rows.

Output

The node outputs a JSON array where each item contains:

  • success: Boolean indicating if the operation succeeded.
  • operation: The name of the operation performed (get-all-rows).
  • metadata: An object containing:
    • source: Fixed string "nocodb".
    • baseId: The base/project ID used.
    • tableId: The table ID used.
    • timestamp: ISO timestamp of when the data was fetched.
    • totalRows: Number of rows retrieved.
    • pageInfo: Pagination information if provided by NocoDB (may be null).
  • data: An array of row objects retrieved from the specified table.

No binary data output is produced by this node.

Example output structure:

[
  {
    "success": true,
    "operation": "get-all-rows",
    "metadata": {
      "source": "nocodb",
      "baseId": "pnnh9o17by6p172",
      "tableId": "mbjxj9y2vmg5vc3",
      "timestamp": "2024-06-01T12:00:00.000Z",
      "totalRows": 10,
      "pageInfo": null
    },
    "data": [
      { "id": 1, "name": "Record 1", ... },
      { "id": 2, "name": "Record 2", ... }
    ]
  }
]

Dependencies

  • Requires access to a self-hosted NocoDB instance with a valid API token.
  • The node expects the NocoDB API to be reachable at the provided base URL.
  • No additional external libraries beyond standard n8n helpers are required.

Troubleshooting

  • Common issues:

    • Invalid or missing API token will cause authentication failures.
    • Incorrect base URL, base ID, or table ID will result in request errors or empty results.
    • Network connectivity problems to the NocoDB instance can cause timeouts or request failures.

  • Error messages:

    • NocoDB API request failed: <error message> indicates an issue with the HTTP request or response from NocoDB. Check credentials, URLs, and network access.
    • The operation "..." is not supported yet. means the node does not support the requested operation.
    • The resource "..." is not known! means the specified resource is invalid or unsupported.

  • Resolution tips:

    • Verify that the API token is correct and has sufficient permissions.
    • Confirm the base URL ends without trailing slashes and points to the correct NocoDB instance.
    • Double-check the base ID and table ID values for typos.
    • Ensure the NocoDB server is running and accessible from the n8n environment.

Links and References

Discussion