Katalogfunktionen

Der Oracle Data Studio-Katalog oder -Katalog ist ein Tool für mehrere Kataloge, mit dem Sie nach Daten und anderen Objekten in Ihrer derzeit verbundenen Autonomous Database sowie in einer Vielzahl anderer verbundener Systeme suchen können.

Mit der Katalog-API-Funktionalität können Sie vernetzte Datenassets von überall in der Cloud und darüber hinaus durchsuchen, suchen und entdecken.

Außerdem können Sie neue Kataloge über andere Systeme mounten und Daten und andere Elemente in der verbundenen Autonomous Database suchen.

Die Katalog-API-Funktionalität ermöglicht das Mounten neuer Kataloge über:
  • Andere autonome Datenbanken in Ihrem Mandanten.
  • Jede andere Datenbank, die über einen DB-Link verbunden werden kann, z.B. eine On-Premise-Datenbank, mit der Autonomous Database eine Verbindung herstellen kann.
  • Gemeinsame Daten, z. B. Daten, die von DataBricks mit Delta Sharing geteilt werden.
  • Vorhandene externe Datenkataloge wie AWS Glue oder der OCI Data Catalog.

Dieser folgende Abschnitt enthält Funktionsbeispiele für die ersten Schritte mit der Oracle Data Studio Catalog-API.

Bevor Sie diese Beispiele verwenden, müssen Sie die ADP-Instanz erstellen und dann eine Verbindung herstellen.
import adp as ords
adp = ords.login('<protocol://host:port>', 'schema_name', 'schema_password')
Catalog = adp.Catalog

Kataloge abrufen - Vorgehensweise

Diese Funktion erhält eine Liste mit Katalogen.

Syntax

Catalog.get_catalogs(search)
Parameter:
  • Suche (Zeichenfolge): Der vom Benutzer bereitgestellte Katalogsuchtext. Dieser Parameter muss beim Erstellen einer Anforderung nicht vom Benutzer angegeben werden. Wenn er weggelassen wird, verwendet das System automatisch den Standardwert None.

Rückgabetyp

Es ist eine JSON-Zeichenfolge

Rücksendungsstruktur
'[

{"label": catalog name (String),

"type": catalog type (String),

"id": catalog id (String),

"details" : catalog details (JSON Nested Object),

"enabled": catalog enabled status (true | false),

"created": catalog create date (String)

"updated": catalog update date (String)},

 ...

]'
Beispiel
import json
import pandas as pd
# catalog api function call
r = Catalog.get_catalogs()
# pandas data frame representation
j = json.loads(r)
pd.json_normalize(j)


Beschreibung von get_catalogs.png folgt
Beschreibung der Abbildung get_catalogs.png

Fehlertyp

JSON-Zeichenkette

Fehlerstruktur

'{"code": error code (Number), "error": error message
    (String)}'

Katalogentitäten abrufen - Vorgehensweise

Diese Funktion erhält eine Liste der Katalogentitäten.

Syntax

Catalog.get_catalog_entities(catalog_name, type, search)
Parameter:
  • catalog_name (Zeichenfolge): Es handelt sich um einen vom Benutzer angegebenen Katalognamen.
  • Typ (Zeichenfolge): Dies ist ein vom Benutzer angegebener Katalogentitätstyp. Dieser Parameter muss beim Erstellen einer Anforderung nicht vom Benutzer angegeben werden. Wenn er weggelassen wird, verwendet das System automatisch den Standardwert TABLE.
  • Katalogentitätstypen: "TABLE", "VIEW", "SCHEMA" usw.
  • Suche (Zeichenfolge): Der vom Benutzer bereitgestellte Katalogsuchtext.
Beispiele
import json
import pandas as pd

# catalog api function call
r = Catalog.get_catalog_entities('CATALOG_DELTA_SHARING_1')

# pandas data frame representation
j = json.loads(r)
pd.json_normalize(j)


Beschreibung von get_catalog_entities.png folgt
Beschreibung der Abbildung get_catalog_entities.png

Rückgabetyp

Es ist eine JSON-Zeichenfolge.

Rücksendungsstruktur
'[

{"label": catalog entity name (String),

"type": catalog entity type (String),

"schema": catalog schema (String),

"id": catalog entity id (String).

"details" : catalog entity details (JSON Nested Object),

"created": catalog entity create date (String)

"updated": catalog entity update date (String)},

...

]'

Fehlertyp

JSON-Zeichenkette

Fehlerstruktur

'{"code": error code (Number), "error": error message (String)}'

Prozedur "Datenbanklinks abrufen"

Diese Funktion erhält eine Liste der Katalogentitäten.

Syntax

Catalog.get_database_links(catalog_name, owner, search)
Parameter:
  • catalog_name (Zeichenfolge): Es handelt sich um einen vom Benutzer angegebenen Katalognamen.
  • Eigentümer (Zeichenfolge): Der vom Benutzer angegebene Name des Katalogeigentümers.
  • Suche (Zeichenfolge): Der vom Benutzer bereitgestellte Katalogsuchtext. Dieser Parameter muss beim Erstellen einer Anforderung nicht vom Benutzer angegeben werden. Wenn er weggelassen wird, verwendet das System automatisch den Standardwert NONE.

Rückgabetyp

Es ist eine JSON-Zeichenfolge.

Rücksendungsstruktur
'[

{"label":  data base link name (String),

"type": database link type (String),

"catalog": data base link catalog (String),

"application": data base link application (String).

"credentialName": data base link credential name (String),

"credentialOwner": data base link credential owner (String),

"hidden": data base link is hidden (String),

"valid": data base link is valid (String),

"created": database link created create date (String)

"updated": database link created update date (String),

]'

Fehlertyp

JSON-Zeichenkette

Fehlerstruktur

'{"code": error code (Number), "error": error message (String)}'

Autonomous Database-Prozedur abrufen

Diese Funktion empfängt autonome Datenbanken von Oracle Data Studio Catalog.

Syntax

Catalog.get_autonomous_database(search)
Parameter:
  • Suche (Zeichenfolge): Der vom Benutzer bereitgestellte Katalogsuchtext. Dieser Parameter muss beim Erstellen einer Anforderung nicht vom Benutzer angegeben werden. Wenn er weggelassen wird, verwendet das System automatisch den Standardwert NONE.

Rückgabetyp

Es ist eine JSON-Zeichenfolge.

Rücksendungsstruktur
'[

{"label": autonomous database name (String),

"type": autonomous database type (String),

"catalog": autonomous database catalog (String),

"application": autonomous database application (String).

"schema": autonomous database schema (String),

"workloadType": autonomous database workload type (String),

"lifecycleState": autonomous database life cycle state (String),

"ocid": autonomous database ocid (String),

"created":  autonomous database create date (String)

"updated":  autonomous database update date (String),
]'

Fehlertyp

JSON-Zeichenkette

Fehlerstruktur

'{"code": error code (Number), "error": error message (String)}'

Katalogprozedur aktivieren

Diese Funktion aktiviert Oracle Data Studio Catalog.

Syntax

Catalog.enable_catalog(catalog_name)
Parameter:
  • catalog_name (Zeichenfolge): Es handelt sich um einen vom Benutzer angegebenen Katalognamen.
Beispiel
# catalog api function call
Catalog.enable_catalog('CATALOG_DELTA_SHARING_1')
Ausgabe
'{ "updated": true }'

Rückgabetyp

Es ist eine JSON-Zeichenfolge.

Rücksendungsstruktur
'{ "updated": operation status (True | False)}'

Fehlertyp

JSON-Zeichenkette

Fehlerstruktur

'{"code": error code (Number), "error": error message (String)}'

Katalogprozedur deaktivieren

Diese Funktion deaktiviert Oracle Data Studio Catalog.

Syntax

Catalog.enable_catalog(catalog_name)
Parameter:
  • catalog_name (Zeichenfolge): Es handelt sich um einen vom Benutzer angegebenen Katalognamen.
Beispiele
# catalog api function call
Catalog.disable_catalog('CATALOG_DELTA_SHARING_1')

Ausgabe

'{ "updated": true }'

Rückgabetyp

Es ist eine JSON-Zeichenfolge.

Rücksendungsstruktur
'{ "updated": operation status (True | False)}'

Fehlertyp

JSON-Zeichenkette

Fehlerstruktur

'{"code": error code (Number), "error": error message (String)}'

Katalog aushängen - Vorgehensweise

Diese Funktion deaktiviert Oracle Data Studio Catalog.

Syntax

Catalog.unmount_catalog(catalog_name)
Parameter:
  • catalog_name (Zeichenfolge): Es handelt sich um einen vom Benutzer angegebenen Katalognamen.
Beispiel
# catalog api function call
Catalog.unmount_catalog('CATALOG_DELTA_SHARING_1')
Ausgabe
'{ "unmounted": true }'

Rückgabetyp

Es ist eine JSON-Zeichenfolge.

Rücksendungsstruktur
'{ "unmounted": operation status (true | false)}'

Fehlertyp

JSON-Zeichenkette

Fehlerstruktur

'{"code": error code (Number), "error": error message (String)}'

Katalogtabellenvorschau - Vorgehensweise

Diese Funktion zeigt eine Vorschau der Oracle Data Studio-Katalogtabelle an.

Syntax

Catalog.preview_catalog_table(catalog_name, table_name, schema_name,
    row_limit)
Parameter:
  • catalog_name (Zeichenfolge): Gibt den Katalognamen an.
  • table_name (String): Gibt den Namen der Katalogtabelle an.
  • schema_name (Zeichenfolge): Gibt den Namen des Katalogschemas an.
  • row_limit (Number): Gibt das Zeilenlimit für die Katalogtabellenvorschau an. Dieser Parameter muss beim Erstellen einer Anforderung nicht vom Benutzer angegeben werden. Wenn er weggelassen wird, verwendet das System automatisch den Standardwert 100.
Beispiel
import pandas as pd

# catalog api function call
q = Catalog.preview_catalog_table(
                           catalog_name = 'CATALOG_DELTA_SHARING_1', 
                           table_name   = 'COVID_19_NYT',                                       
                           schema_name  = 'DEFAULT')

# pandas data frame representation
pd.DataFrame.from_records(q)

Ausgabe


Beschreibung von Vorschau-catalog.png folgt
Beschreibung der Abbildung Vorschau-Katalog.png

Rückgabetyp

Es ist eine JSON-Zeichenfolge.

Rücksendungsstruktur
'[{"columnName": "row_value",.. }, {}, ...]'

Fehlertyp

JSON-Zeichenkette

Fehlerstruktur

'{"code": error code (Number), "error": error message (String)}'

OCI Data Catalog-Prozedur mounten

Diese Funktion mountet OCI Data Catalog.

Syntax

Catalog.mount_oci_data_catalog(catalog_name, oci_catalog_credential, oci_catalog_region, oci_catalog_name, oci_storage_credential)
Parameter:
  • catalog_name (Zeichenfolge): Gibt den Katalognamen an.
  • oci_catalog_credential (Zeichenfolge): Gibt OCI-Katalogzugangsdaten an.
  • oci_catalog_region (String): Gibt die OCI-Katalogregion an.
  • oci_catalog_name (String): Gibt den OCI-Katalognamen an.
  • oci_storage_credential (String): Gibt OCI-Speicherzugangsdaten an. Dieser Parameter muss beim Erstellen einer Anforderung nicht vom Benutzer angegeben werden. Wenn er weggelassen wird, verwendet das System automatisch den Standardwert None.

Rückgabetyp

Es ist eine JSON-Zeichenfolge.

Rücksendungsstruktur
'[{"catalogName": catalog name (String),
   "shareName": share name (String)}]'

Fehlertyp

JSON-Zeichenkette

Fehlerstruktur

'{"code": error code (Number), "error": error message (String)}'

Autonomous Database-Freigabekatalog mounten - Vorgehensweise

Mit dieser Funktion wird der gemeinsam verwendete Katalog für autonome Datenbanken gemountet.

Syntax

Catalog.mount_autonomous_database_catalog(catalog_name, database_name, create_database_link,
      database_link_name, credential_name)
Parameter:
  • catalog_name (Zeichenfolge): Gibt den Katalognamen an.
  • database_name (Zeichenfolge): Gibt den Namen der autonomen Datenbank an.
  • create_database_link (boolesch): Erstellt den Namensmodus für Datenbanklinks. Dieser Parameter muss beim Erstellen einer Anforderung nicht vom Benutzer angegeben werden. Wenn er weggelassen wird, verwendet das System automatisch den Standardwert False.
  • database_link_name (Zeichenfolge): Es handelt sich um einen Datenbanklinknamen. Dieser Parameter muss beim Erstellen einer Anforderung nicht vom Benutzer angegeben werden. Wenn er weggelassen wird, verwendet das System automatisch den Standardwert False.
  • credential_name (Zeichenfolge): Dies ist ein Swift-Zugangsdatenname. Dieser Parameter muss beim Erstellen einer Anforderung nicht vom Benutzer angegeben werden. Wenn er weggelassen wird, verwendet das System automatisch den Standardwert False.

Rückgabetyp

Es ist eine JSON-Zeichenfolge.

Rücksendungsstruktur
'[{"catalogName": catalog name (String),
   "shareName": share name (String)}]'

Fehlertyp

JSON-Zeichenkette

Fehlerstruktur

'{"code": error code (Number), "error": error message (String)}'

Shares-Katalog mounten - Vorgehensweise

Mit dieser Funktion wird Oracle Data Studio Shares Catalog gemountet.

Syntax

Catalog.mount_shares_catalog(catalog_name, share_name,
    share_provider)
Parameter:
  • catalog_name (Zeichenfolge): Gibt den Katalognamen an.
  • share_name (Zeichenfolge): Dies ist ein Share-Name.
  • share_provider (Zeichenfolge): Der Name des Freigabeproviders.
Beispiel
Mount Shares Catalog# catalog api function call
Catalog.mount_shares_catalog (
        catalog_name   = 'CATALOG_DELTA_SHARING_1',
        share_name     = 'DELTA_SHARING',
        share_provider = 'PROVIDER_DELTA_SHARING_1')
Ausgabe
'[{"catalogName":"CATALOG_DELTA_SHARING_1","shareName":"DELTA_SHARING"}]'

Rückgabetyp

Es ist eine JSON-Zeichenfolge.

Rücksendungsstruktur
'[{"catalogName": catalog name (String),
"shareName": share name (String)}]'

Fehlertyp

JSON-Zeichenkette

Fehlerstruktur

'{"code": error code (Number), "error": error message (String)}'

Übergeordnetes Thema: Mit Python Data Studio-API für Autonomous Database arbeiten