PostgreSQL Table Info¶
Retrieves structural information for a specific PostgreSQL table. It loads credentials, connects to the database, and returns a human-readable summary along with a JSON payload describing the table. Typical details include columns, data types, and other metadata.
Usage¶
Use this node when you need to inspect a table before writing queries or building data pipelines. It’s commonly used alongside List Tables to discover available tables and Visual Query/Query Builder nodes to design queries informed by column metadata.
Inputs¶
| Field | Required | Type | Description | Example |
|---|---|---|---|---|
| credentials_path | True | STRING | Path or reference to PostgreSQL credentials configured for the service. | |
| timeout | True | INT | Maximum time (in seconds) to wait for the operation before failing. | 30 |
| table_name | True | STRING | Name of the table to retrieve information for. | users |
| schema | True | STRING | Schema where the table resides. | public |
Outputs¶
| Field | Type | Description | Example |
|---|---|---|---|
| text | STRING | Readable summary of the table information. | Table Info: public.users - id: integer (PK) - email: text (unique) - created_at: timestamp without time zone |
| json | STRING | JSON-encoded table information suitable for programmatic use. | {"data": [{"column": "id", "data_type": "integer", "is_nullable": false, "is_primary_key": true}, {"column": "email", "data_type": "text", "is_nullable": false, "is_unique": true}]} |
| html | STRING | HTML output (not populated by default for this node). | |
| xlsx | BYTES | Excel output (not populated by default for this node). | |
| BYTES | PDF output (not populated by default for this node). |
Important Notes¶
- This node requires valid PostgreSQL credentials; ensure your credentials file or reference is correctly configured.
- The default schema is 'public'; adjust the schema input if your table resides elsewhere.
- The output includes both a readable summary (text) and a machine-friendly JSON string.
- Returned metadata can vary depending on database permissions and server configuration.
- Timeouts will fail the operation if the database does not respond within the specified time.
Troubleshooting¶
- Authentication or connection errors: Verify credentials_path and network access to the database.
- Table not found: Confirm the table_name and schema are correct and that the table exists.
- Insufficient privileges: Ensure the database user has permissions to read table metadata.
- Timeouts: Increase the timeout value or check database performance/connectivity.
- Empty or partial metadata: Confirm that system catalog access is permitted and that the user has adequate privileges.