PostgreSQL Table Info¶
Retrieves structural information about a PostgreSQL table (e.g., columns, data types, constraints) using the configured database credentials. Returns a human-readable summary along with the raw JSON metadata. Useful for exploring schema details before writing queries or building data pipelines.
Usage¶
Use this node when you need to inspect a table’s schema in a PostgreSQL database. Provide the credentials file path, select the target schema and table, and run the node to get both a formatted summary and the underlying JSON metadata. This is typically used ahead of crafting queries, validating integrations, or documenting data models.
Inputs¶
| Field | Required | Type | Description | Example |
|---|---|---|---|---|
| credentials_path | True | STRING | Path to the stored credentials configuration for the PostgreSQL service. The credentials must match the 'postgres' credential template. | /workspace/credentials/postgres.json |
| timeout | True | INT | Maximum time in seconds to wait for the operation before timing out. | 60 |
| table_name | True | STRING | Name of the table to retrieve information about. | users |
| schema | True | STRING | Name of the database schema where the table resides. | public |
Outputs¶
| Field | Type | Description | Example |
|---|---|---|---|
| text | STRING | Formatted, human-readable summary of the table structure. | Table Info: public.users - Columns: id (integer, not null) email (text, not null) created_at (timestamp, null) - Primary Key: users_pkey (id) - Indexes: users_email_idx (email) - Foreign Keys: ... |
| json | JSON | Raw JSON metadata returned by the service detailing columns, data types, constraints, and other table properties. | {"data": {"columns": [{"name": "id", "type": "integer", "nullable": false}], "primary_key": ["id"], "indexes": [], "foreign_keys": []}} |
| html | HTML | HTML rendition of the results if available; otherwise an empty string. | |
| xlsx | BYTES | Binary Excel content if exported; otherwise empty. | |
| BYTES | Binary PDF content if exported; otherwise empty. |
Important Notes¶
- Credentials: Requires a valid PostgreSQL credential configuration (credential template: "postgres").
- Schema and table names: The default schema is "public". Ensure the specified table exists in the given schema.
- Permissions: The database user in the provided credentials must have sufficient privileges to read metadata.
- Timeouts: Operations respect the specified timeout; large or slow systems may require higher values.
- Outputs: The node returns a formatted text summary and the raw JSON. Other output formats may be empty if not generated.
Troubleshooting¶
- Authentication failed: Verify credentials_path points to a valid file and that the credentials match the target database.
- Table not found: Check spelling, schema selection, and case sensitivity for the table_name and schema.
- Insufficient privileges: Ensure the user has metadata access (e.g., to information_schema or catalog views).
- Network/connection issues: Confirm the database is reachable from your environment and firewall rules allow access.
- Timeouts: Increase the timeout input if the database is slow or under heavy load.