Set Up an External Data Source
- how-to
To provide query access to data that resides in external object storage, you create an external link and associate it with an external collection.
Supported External Sources
Operational Insights supports external links to the following object storage providers:
-
Amazon S3
-
S3-compatible object stores
-
Azure Blob Storage
-
Google Cloud Storage (GCS)
This data remains in the source location — Operational Insights does not copy it into a collection. You can query Delta tables residing in S3 buckets, S3 objects, or Azure Blob Storage containers, in one of the following formats:
-
JSON
-
CSV
-
TSV
-
Parquet
-
Avro
Apache Iceberg
Operational Insights also supports read-only access to Apache Iceberg tables through external catalogs. Unlike S3 external collections, Iceberg tables are registered via a catalog entity rather than a direct link to object storage.
To query Iceberg data:
-
Register a catalog using
CREATE CATALOG. -
Register an Iceberg table on that catalog using
CREATE EXTERNAL COLLECTION.
See Iceberg Support for the full list of supported catalog types and prerequisites.
You can also register catalogs and Iceberg collections with the workbench, as described in Set Up Iceberg Data with the Workbench.
Set Up Iceberg Data with the Workbench
Before you begin, create the link or links that authenticate access to the catalog and to the object storage that holds its data files. See Query Iceberg Tables.
To register a catalog:
-
In the Web Console, click Workbench in the navigation bar.
-
In the explorer, next to Catalogs, click + new catalog. The Create Catalog dialog opens.
-
In Catalog Name, enter a name for the catalog. The Catalog Type is always Iceberg.
-
In Catalog Source, select the kind of catalog: REST, AWS Glue, AWS Glue REST, S3 Tables, BigLake Metastore, Nessie, or Nessie REST.
-
In Link, select the link that authenticates access to the catalog.
-
Complete the fields for the selected source, such as URI, Warehouse, SigV4 Signing Name, SigV4 Signing Region, or Quota Project ID. These correspond to the
WITHproperties for that source, described in CREATE CATALOG. -
Optionally, under Additional Parameters (Optional), click + Add Parameter to add any other property as a name and value pair.
-
Click Save.
The catalog appears under Catalogs in the explorer. Expand it to see its type, source, and link, or to drop it.
To add an Iceberg collection on a catalog:
-
In the explorer, under Catalogs, click + collection next to the catalog. The Add Iceberg Collection dialog opens.
-
Enter a Collection Name, and select the Database and Scope for the collection.
-
Select the Iceberg Namespace and Table Name. The lists are read from the catalog.
-
Optionally, select the type conversions to apply: Decimal to Double, Timestamp to Long, Time to Int, or Date to Int, and enter a Timezone. See CREATE EXTERNAL COLLECTION.
-
In Link, select the link that authenticates access to the table’s data files.
-
Optionally, under Time Travel, pin the collection to a Snapshot ID or a Snapshot Timestamp.
-
Click Save.
Creating a Link with an SDK
Operational Insights uses different types of links to store credentials for accessing different types of data sources. You can use the UI to create links.
To create a link with an SDK, note the following:
-
External: in an SDK, you use the
S3ExternalAnalyticsLinkclass and then theAnalyticsIndexManagerclass to create the link.
For more information about data sources, see Data Model & Hierarchy.