The __admin Dataset
The __admin dataset is a special, read-only dataset that reflects the state of current deployed environment.
It is currently considered "internal" to the Island team, and used by features such as the Command Line tool.
The __admin dataset can only be reached via IAM authentication; it is forbidden on the public (Cognito-authenticated) endpoint.
The easiest way to reach out to the __admin dataset is to use the Gateway Lambda, but it is also
reachable using GraphQL or REST on the iam endpoint.
The following schemas are available in the __admin dataset:
| Schema | Description | Notes |
|---|---|---|
Environment | The current environment | Only one Environment is present per deployed Depot environment, so "listing environments" will return the one available environment. |
Dataset | The datasets available in the environment | |
SchemaNamingMapping | A mapping between logical "depot" names and the deployed "sql" names for each schema | only on Snowflake and Postgres locations |
Store | The stores available in the environment | deprecated? obsolete? |
Transaction | The transactions currently active in the environment | deprecated? obsolete? |
Location | The Locations currently used in the environment | |
Executors | The Executors currently available in the environment |
The Depot schema describing the contents of these schemas is available in the stage-depot-platform repository,
under the name Admin.yml. It broadly matches the input descriptions used by a Service in Depot CDK.
The regular Depot "expand" semantics are available; it is possible to expand location on a Dataset to get the
characteristics of the underlying location; or to expand executor on a Location to get the corresponding Executor
characteristics. Or to expand dataset, dataset.location and dataset.location.executor from a Deployed Schema to
get, for a given schema, the SQL names, the JDBC endpoint and location of credentials in a single round-trip.