Skip to content

sys.external_location

A system view that returns information about the external location objects in the database. This view does not return information about PRIMARY storage locations.

Column NameData TypeDescription
external_location_idbigintUnique ID of the external location object.
nametextName of the external location object.
owner_idbigintUnique ID of the user who owns the external location object. Join key for sys.user and sys.role.
external_storage_idbigintUnique ID of the external storage object. Join key for sys.external_storage.
external_format_idbigintUnique ID of the external format object. Join key for sys.external_format.
pathtextPath to the location of the S3 files.
creation_timetimestamptzWhen the external location object was created.
modify_timetimestamptzThis value is currently the same as creation_time because external location objects cannot be modified.
usage_typevarchar(256)Always shows EXTERNAL. Although every instance has a PRIMARY storage location, these locations are not shown in this view.

Example

premdb=# select * from sys.external_location where name='premdbs3data';
-[ RECORD 1 ]--------+------------------------------
external_location_id | 137329
name                 | premdbs3data
owner_id             | 137192
external_storage_id  | 137327
external_format_id   | 137328
path                 | yb-sampledata-d4f1c23ea7
creation_time        | 2022-06-14 11:58:22.390847-07
modify_time          | 2022-06-14 11:58:22.390847-07
usage_type           | EXTERNAL

Parent topic:System Views