Pipelines reference - PGFS
This section provides reference documentation for EDB Postgres AI - AI Accelerator Pipelines PGFS. It includes information on the functions and views available in the pgfs extension that gives aidb access to S3-compatible file systems and local file systems.
pgfs
Functions
- pgfs.create_foreign_table
- pgfs.create_storage_location
- pgfs.create_storage_location_with_foreign_table
- pgfs.delete_storage_location
- pgfs.list_storage_locations
- pgfs.get_storage_location
- pgfs.update_storage_location
Functions
pgfs.create_foreign_table
Creates a foreign table in the database.
Parameters
Parameter | Type | Default | Description |
---|---|---|---|
table_name | text | ||
server_name | text |
Example
pgfs.create_storage_location
Creates a storage location in the database.
Parameters
Parameter | Type | Default | Description |
---|---|---|---|
name | text | Name for storage location | |
url | text | URL for this storage location (prefix s3: or file: ) | |
msl_id | uuid | Unused | |
options | jsonb | Options for the storage location | |
credentials | jsonb | Credentials for the storage location |
Example
pgfs.create_storage_location_with_foreign_table
Creates a storage location in the database and associates it with a foreign table.
Parameters
Parameter | Type | Default | Description |
---|---|---|---|
storage_location_name | text | ||
url | text | ||
msl_id | uuid | ||
options | json | ||
credentials | json |
Example
pgfs.delete_storage_location
Deletes a storage location from the database.
Parameters
Parameter | Type | Default | Description |
---|---|---|---|
storage_location_name | text |
Example
pgfs.get_default_storage_location
Returns the default storage location.
Returns
Column | Type | Description |
---|---|---|
default_storage_location | text |
Example
pgfs.get_storage_location
Returns information about a storage location.
Parameters
Parameter | Type | Default | Description |
---|---|---|---|
storage_location_name | text |
Returns
Column | Type | Description |
---|---|---|
name | text | |
url | text | |
msl_id | uuid | |
options | json | |
credentials | json |
Example
pgfs.list_storage_locations
Lists all storage locations in the database.
Returns
Column | Type | Description |
---|---|---|
name | text | |
url | text | |
msl_id | uuid | |
options | json | |
credentials | json |
Example
pgfs.set_default_storage_location
Sets the default storage location.
Parameters
Parameter | Type | Default | Description |
---|---|---|---|
storage_location_name | text |
Example
pgfs.update_storage_location
Updates a storage location in the database.
Parameters
Parameter | Type | Default | Description |
---|---|---|---|
name | text | ||
url | text | ||
msl_id | uuid | ||
options | json | ||
credentials | json |
Example
Views
There are no user-facing views in the pgfs
schema.
Tables
There are no user-facing tables in the pgfs
schema.
Could this page be better? Report a problem or suggest an addition!