- Support
- Integrations
- Data Catalog
Data Catalog
Oracle Cloud integration · 26 node(s).
00Overview
Manage your Oracle Cloud Data Catalog straight from a flow — create, move and tidy up catalog instances, register the databases, object stores and streams you want catalogued, and test the connections that reach them. Browse the tables, files and streams harvested from each source, and build a shared business glossary of terms so everyone describes the same data the same way. Every list action walks the results for you, so you can drive reporting or clean-up jobs across a whole catalog without paging through them by hand.
Every field below is exactly what you see in the Flomation editor. Fields marked ● live picker let you choose from a list pulled live from your account — no IDs to look up.
01Connecting Data Catalog
- The node's Authentication dropdown offers two paths: Connect Oracle Cloud (recommended) uses a managed connection you set up once in Flomation, while API signing key (advanced) lets you supply an existing key pair's details directly.
- For Connect Oracle Cloud, open Environment → Credentials in Flomation, click Add and choose Oracle Cloud (API key): name the connection, paste your Tenancy OCID and home Region, and click Create — Flomation generates the signing key plus a one-click Deploy to Oracle Cloud stack that creates a dedicated, scoped user and uploads the public key for you, then copy the user OCID the stack outputs into User OCID, click Connect, and the connection appears in the node's Oracle Cloud connection field.
- For API signing key (advanced), sign in to the OCI Console and open Profile → My profile → API keys, choose Add API key, download the private key, and copy the Configuration file preview — it lists your Tenancy OCID, User OCID, Region and Key Fingerprint to fill into the matching node fields, and add a Private Key Passphrase only if you encrypted the key.
- Find your Compartment OCID under Identity & Security → Compartments and set it in the node's Compartment OCID field — it is required on every action, whichever authentication method you use.
- Store the private key PEM as a Flomation environment secret (e.g.
datacatalog_secret) and select it in the node's Private Key (PEM) field, so the key is never pasted into the flow itself.
| Field | Type | Details | |
|---|---|---|---|
| Authentication | string | Connect Oracle Cloud, API signing key (advanced) | |
| Oracle Cloud connection | credential | Pick a connected Oracle Cloud account | |
| Region | string | e.g. uk-london-1 | |
| Private Key (PEM) | secret | The API signing private key — full PEM, incl. BEGIN/END lines | |
| Private Key Passphrase | secret | Only if the key is encrypted (optional) | |
| Tenancy OCID | string | ocid1.tenancy.oc1..aaaa… | |
| User OCID | string | ocid1.user.oc1..aaaa… | |
| Key Fingerprint | string | aa:bb:cc:… fingerprint of the uploaded API key |
Pick an Environment on your flow (Flow Settings → Environment) so the secret resolves. Secret fields never show the value — they reference ${secrets.your_secret}.
02Catalog
OCI Data Catalog: Change Catalog Compartment
oracle/datacatalog/catalog_change_compartment · Action
Move a Data Catalog instance into a different compartment — the catalog keeps its OCID, only its compartment placement changes. Returns a work-request id.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… (the catalog to move) |
| Destination Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… (where to move the catalog) |
Returns: tool_result, id, work_request_id, success, error
OCI Data Catalog: Create Catalog
oracle/datacatalog/catalog_create · Action
Create a Data Catalog instance in a compartment. Returns a work-request id — poll Get Catalog until it is ACTIVE before use.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Display Name | string | A name for the catalog (optional) |
Returns: tool_result, work_request_id, success, error
OCI Data Catalog: Delete Catalog
oracle/datacatalog/catalog_delete · Action
Delete a Data Catalog instance by its OCID, removing it and every data asset, connection and glossary harvested into it. Returns a work-request id to track the asynchronous delete.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… of the catalog to delete |
Returns: tool_result, id, work_request_id, success, error
OCI Data Catalog: Get Catalog
oracle/datacatalog/catalog_get · Action
Fetch a single Data Catalog instance by its OCID — its display name, object count, service URLs and lifecycle state.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… |
Returns: tool_result, catalog, id, lifecycle_state, success, error
OCI Data Catalog: List Catalogs
oracle/datacatalog/catalog_list · Action
List the Oracle Cloud Data Catalog instances in a compartment, optionally filtered by exact display name and lifecycle state. Walks pagination up to a safe cap.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… (use the tenancy OCID for the root) |
| Display Name Filter | string | Only catalogs with this exact name, case-insensitive (optional) | |
| Lifecycle State | string | Only catalogs in this state (optional) — choices: Creating, Active, Inactive, Updating, Deleting, Deleted, Failed, Moving | |
| Page Size | string | Items per page, 1–100 (optional) |
Returns: tool_result, catalogs, count, truncated, success, error
OCI Data Catalog: Update Catalog
oracle/datacatalog/catalog_update · Action
Partially update a Data Catalog instance — change only the display name you supply; a blank field is left unchanged. Returns a work-request id; poll Get Catalog until ACTIVE.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… — the catalog to update |
| Display Name | string | New name (leave blank to keep unchanged) |
Returns: tool_result, id, work_request_id, success, error
03Connection
OCI Data Catalog: Create Connection
oracle/datacatalog/connection_create · Action
Create a connection to a data asset. Supply the connection type key plus its type-specific properties (host, username, …) and any encrypted properties (password, …); returns the connection with its immutable Key.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… (the catalog the data asset lives in) |
| Data Asset Key | string | Required | The parent data asset's key (not an OCID) |
| Display Name | string | Required | A name for the connection |
| Connection Type Key | string | Required | The connection type's key — list the data asset's connection types to find it |
| Properties (JSON) | text | Type-specific properties keyed by category, e.g. {"default":{"host":"db1","username":"user1"}} (optional) | |
| Encrypted Properties (JSON) | text | Sensitive properties keyed by category, e.g. {"default":{"password":"secret"}} (optional) | |
| Description | string | Optional | |
| Default Connection | boolean | Make this the data asset's default connection (optional) |
Returns: tool_result, connection, key, success, error
OCI Data Catalog: Delete Connection
oracle/datacatalog/connection_delete · Action
Delete a connection from a data asset in an OCI Data Catalog by its key.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… of the catalog |
| Data Asset Key | string | Required | The key of the parent data asset |
| Connection Key | string | Required | The key of the connection to delete |
Returns: tool_result, key, success, error
OCI Data Catalog: Get Connection
oracle/datacatalog/connection_get · Action
Fetch a single Data Catalog connection by its key — its type, default flag and lifecycle state.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… |
| Data Asset Key | string | Required | The parent data asset's key |
| Connection Key | string | Required | The connection's key |
Returns: tool_result, connection, key, success, error
OCI Data Catalog: List Connections
oracle/datacatalog/connection_list · Action
List the connections defined on a data asset in a Data Catalog. Optionally filter by exact display name. Walks pagination up to a safe cap.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… (use the tenancy OCID for the root) |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… |
| Data Asset Key | string | Required | The immutable key of the parent data asset |
| Display Name Filter | string | Only connections with this exact name (optional) |
Returns: tool_result, connections, count, truncated, success, error
OCI Data Catalog: Test Connection
oracle/datacatalog/connection_test · Action
Validate a Data Catalog connection against its data asset and return the validation status and message.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… |
| Data Asset Key | string | Required | The parent data asset's key |
| Connection Key | string | Required | The connection's key to validate |
Returns: tool_result, result, status, message, success, error
04Data
OCI Data Catalog: Create Data Asset
oracle/datacatalog/data_asset_create · Action
Register a data asset in a Data Catalog — a physical data source (database, object store or stream) identified afterwards by its returned Key.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… — the catalog to create the asset in |
| Display Name | string | Required | A friendly name for the data asset |
| Type Key | string | Required | The data asset type key (obtain from the catalog's /types endpoint) |
Returns: tool_result, data_asset, key, success, error
OCI Data Catalog: Delete Data Asset
oracle/datacatalog/data_asset_delete · Action
Delete a data asset from a Data Catalog by its key, removing it and its harvested metadata.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… of the catalog |
| Data Asset Key | string | Required | The unique key of the data asset to delete |
Returns: tool_result, key, success, error
OCI Data Catalog: Get Data Asset
oracle/datacatalog/data_asset_get · Action
Fetch a single Data Catalog data asset by its key — its display name, type, external key and lifecycle state.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… |
| Data Asset Key | string | Required | The data asset's unique key (not an OCID) |
Returns: tool_result, data_asset, key, success, error
OCI Data Catalog: List Data Assets
oracle/datacatalog/data_asset_list · Action
List the data assets registered in a catalog. Optionally filter by exact display name. Walks pagination up to a safe cap.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… (use the tenancy OCID for the root) |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… — the catalog to list data assets from |
| Display Name Filter | string | Only data assets with this exact name (optional) | |
| Page Size | string | Items per page (optional; pagination still walks all pages) |
Returns: tool_result, data_assets, count, truncated, success, error
OCI Data Catalog: Update Data Asset
oracle/datacatalog/data_asset_update · Action
Partially update a Data Catalog data asset — change only the display name or description you supply; blank fields are left unchanged.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… — the catalog the data asset belongs to |
| Data Asset Key | string | Required | The data asset's unique key (not an OCID) |
| Display Name | string | New name (leave blank to keep unchanged) | |
| Description | string | New description (leave blank to keep unchanged) |
Returns: tool_result, data_asset, key, success, error
05Entity
OCI Data Catalog: Get Entity
oracle/datacatalog/entity_get · Action
Fetch a single Data Catalog data entity by its key within a data asset — its business name, type, path, harvest status and lifecycle state.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… |
| Data Asset Key | string | Required | The parent data asset's key |
| Entity Key | string | Required | The data entity's key |
Returns: tool_result, entity, key, success, error
OCI Data Catalog: List Entities
oracle/datacatalog/entity_list · Action
List the data entities under a data asset in a Data Catalog. Optionally filter by exact display name or cap the number of results per page. Walks pagination up to a safe cap.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… (use the tenancy OCID for the root) |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… |
| Data Asset Key | string | Required | The immutable key of the parent data asset (not an OCID) |
| Display Name Filter | string | Only entities with this exact name — case insensitive (optional) | |
| Page Size | string | Items per page (optional; pagination still walks all pages) |
Returns: tool_result, entities, count, truncated, success, error
06Glossary
OCI Data Catalog: Create Glossary
oracle/datacatalog/glossary_create · Action
Create a business glossary in a Data Catalog — a container for the controlled vocabulary of terms that describe your data assets.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… — the catalog to create the glossary in |
| Display Name | string | Required | A name for the glossary |
| Description | string | Optional |
Returns: tool_result, glossary, key, success, error
OCI Data Catalog: Delete Glossary
oracle/datacatalog/glossary_delete · Action
Delete a business glossary from a Data Catalog by its key.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… of the catalog |
| Glossary Key | string | Required | The glossary's unique key (not an OCID) |
Returns: tool_result, key, success, error
OCI Data Catalog: Get Glossary
oracle/datacatalog/glossary_get · Action
Fetch a single Data Catalog business glossary by its key — its display name, description, owner, workflow status and lifecycle state.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… |
| Glossary Key | string | Required | The immutable key of the glossary |
Returns: tool_result, glossary, key, success, error
OCI Data Catalog: List Glossaries
oracle/datacatalog/glossary_list · Action
List the business glossaries in a Data Catalog. Optionally filter by exact display name or cap the number of results. Walks pagination up to a safe cap.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… (use the tenancy OCID for the root) |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… |
| Display Name Filter | string | Only glossaries with this exact name (optional) | |
| Limit | string | Max items to request per page (optional) |
Returns: tool_result, glossaries, count, truncated, success, error
07Term
OCI Data Catalog: Create Term
oracle/datacatalog/term_create · Action
Create a business term in a glossary — a controlled piece of vocabulary that gives your data assets shared business meaning.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… — the catalog the glossary belongs to |
| Glossary Key | string | Required | The key of the glossary to create the term in |
| Display Name | string | Required | A name for the term |
| Description | string | Optional |
Returns: tool_result, term, key, success, error
OCI Data Catalog: Delete Term
oracle/datacatalog/term_delete · Action
Delete a business glossary term from a Data Catalog by its key.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… of the catalog |
| Glossary Key | string | Required | Key of the glossary the term belongs to |
| Term Key | string | Required | Key of the term to delete |
Returns: tool_result, key, success, error
OCI Data Catalog: Get Term
oracle/datacatalog/term_get · Action
Fetch a single business glossary term by its key — its display name, description, workflow status and lifecycle state.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… |
| Glossary Key | string | Required | The parent glossary's key |
| Term Key | string | Required | The glossary term's key |
Returns: tool_result, term, key, success, error
OCI Data Catalog: List Terms
oracle/datacatalog/term_list · Action
List the business glossary terms in a glossary, optionally filtered by exact display name. Walks pagination up to a safe cap.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… (use the tenancy OCID for the root) |
| Catalog OCID | string | Required | ocid1.datacatalog.oc1..aaaa… — the catalog to query |
| Glossary Key | string | Required | The parent glossary's key (not an OCID) |
| Display Name Filter | string | Only terms with this exact name — case insensitive (optional) |
Returns: tool_result, terms, count, truncated, success, error
08Notes & Limitations
Behaviours and constraints worth knowing before you build with these nodes.
- Creating, deleting, updating and moving a catalog run asynchronously and return only a work-request id, so a catalog is not ready to use until Get Catalog reports its lifecycle state as
ACTIVE. - Data assets, connections, glossaries, terms and entities are addressed by an immutable Key rather than an OCID, and each Key is only meaningful alongside its parent — its catalog, data asset or glossary — which you must supply on every call.
- Deleting a catalog permanently removes every data asset, connection and glossary harvested into it, not just the catalog record itself.
- List actions stop after a fixed internal page cap and flag the result as truncated, so a very large source can return partial results — apply the exact display-name filter to narrow a catalog that holds many objects.
- A freshly created or uploaded API signing key can take up to about 90 seconds to become active in Oracle Cloud, so if a connection test fails right after setup, wait a moment and try again.