카탈로그 함수

Oracle Data Studio Catalog 또는 Catalog는 현재 연결된 Autonomous Database 및 기타 다양한 접속된 시스템에서 데이터 및 기타 객체를 검색할 수 있는 방법을 제공하는 다중 카탈로그 도구입니다.

카탈로그 API 기능을 사용하면 클라우드 및 그 이후 어디에서나 연결된 데이터 자산을 탐색, 검색 및 검색할 수 있습니다.

또한 다른 시스템을 통해 새 카탈로그를 마운트하고 연결된 Autonomous Database에서 데이터 및 기타 항목을 검색할 수 있습니다.

카탈로그 API 기능을 통해 새 카탈로그를 마운트할 수 있습니다.
  • 테넌시의 기타 자율운영 데이터베이스입니다.
  • DB 링크를 사용하여 연결할 수 있는 기타 모든 데이터베이스(예: Autonomous Database가 연결할 수 있는 온프레미스 데이터베이스)입니다.
  • 공유 데이터(예: 델타 공유를 사용하여 DataBricks에서 공유된 데이터)입니다.
  • AWS Glue 또는 OCI Data Catalog와 같은 기존 외부 데이터 카탈로그.

아래 섹션에서는 Oracle Data Studio Catalog API 사용을 시작하는 데 도움이 되는 함수 예제를 제공합니다.

이러한 예제를 사용하려면 먼저 ADP 인스턴스를 생성한 다음 연결해야 합니다.
import adp as ords
adp = ords.login('<protocol://host:port>', 'schema_name', 'schema_password')
Catalog = adp.Catalog

카탈로그 가져오기 프로시저

이 함수는 카탈로그 목록을 수신합니다.

구문

Catalog.get_catalogs(search)
매개변수:
  • search (String): 사용자가 제공한 카탈로그 검색 텍스트입니다. 이 매개변수는 요청 시 사용자가 제공할 필요가 없으며, 이 매개변수를 생략할 경우 시스템에서 자동으로 기본값 None를 사용합니다.

반환 유형

JSON 문자열입니다.

반품 구조
'[

{"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)},

 ...

]'
예
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)


다음에 대한 get_catalogs.png 설명
그림 get_catalogs.png에 대한 설명

오류 유형

JSON 문자열

오류 구조

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

카탈로그 엔티티 가져오기 프로시저

이 함수는 카탈로그 엔티티 목록을 수신합니다.

구문

Catalog.get_catalog_entities(catalog_name, type, search)
매개변수:
  • catalog_name (String): 사용자가 제공한 카탈로그 이름입니다.
  • type (String): 사용자가 제공한 카탈로그 엔티티 유형입니다. 이 매개변수는 요청 시 사용자가 제공할 필요가 없으며, 이 매개변수를 생략할 경우 시스템에서 자동으로 기본값 TABLE를 사용합니다.
  • 카탈로그 엔티티 유형: 'TABLE', 'VIEW', 'SCHEMA' 등
  • search (String): 사용자가 제공한 카탈로그 검색 텍스트입니다.
예제
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)


다음은 get_catalog_entities.png에 대한 설명입니다.
그림 get_catalog_entities.png에 대한 설명

반환 유형

JSON 문자열입니다.

반품 구조
'[

{"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)},

...

]'

오류 유형

JSON 문자열

오류 구조

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

데이터베이스 링크 가져오기 프로시저

이 함수는 카탈로그 엔티티 목록을 수신합니다.

구문

Catalog.get_database_links(catalog_name, owner, search)
매개변수:
  • catalog_name (String): 사용자가 제공한 카탈로그 이름입니다.
  • 소유자(문자열): 사용자가 제공한 카탈로그 소유자 이름입니다.
  • search (String): 사용자가 제공한 카탈로그 검색 텍스트입니다. 이 매개변수는 요청 시 사용자가 제공할 필요가 없으며, 이 매개변수를 생략할 경우 시스템에서 자동으로 기본값 NONE를 사용합니다.

반환 유형

JSON 문자열입니다.

반품 구조
'[

{"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),

]'

오류 유형

JSON 문자열

오류 구조

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

Autonomous Database 가져오기 절차

이 기능은 Oracle Data Studio Catalog 자율운영 데이터베이스를 수신합니다.

구문

Catalog.get_autonomous_database(search)
매개변수:
  • search (String): 사용자가 제공한 카탈로그 검색 텍스트입니다. 이 매개변수는 요청 시 사용자가 제공할 필요가 없으며, 이 매개변수를 생략할 경우 시스템에서 자동으로 기본값 NONE를 사용합니다.

반환 유형

JSON 문자열입니다.

반품 구조
'[

{"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),
]'

오류 유형

JSON 문자열

오류 구조

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

카탈로그 프로시저 사용

이 기능은 Oracle Data Studio 카탈로그를 사용으로 설정합니다.

구문

Catalog.enable_catalog(catalog_name)
매개변수:
  • catalog_name (String): 사용자가 제공한 카탈로그 이름입니다.
예
# catalog api function call
Catalog.enable_catalog('CATALOG_DELTA_SHARING_1')
출력
'{ "updated": true }'

반환 유형

JSON 문자열입니다.

반품 구조
'{ "updated": operation status (True | False)}'

오류 유형

JSON 문자열

오류 구조

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

카탈로그 프로시저 사용 안함

이 기능은 Oracle Data Studio 카탈로그를 사용 안함으로 설정합니다.

구문

Catalog.enable_catalog(catalog_name)
매개변수:
  • catalog_name (String): 사용자가 제공한 카탈로그 이름입니다.
예제
# catalog api function call
Catalog.disable_catalog('CATALOG_DELTA_SHARING_1')

출력

'{ "updated": true }'

반환 유형

JSON 문자열입니다.

반품 구조
'{ "updated": operation status (True | False)}'

오류 유형

JSON 문자열

오류 구조

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

카탈로그 마운트 해제 프로시저

이 기능은 Oracle Data Studio 카탈로그를 사용 안함으로 설정합니다.

구문

Catalog.unmount_catalog(catalog_name)
매개변수:
  • catalog_name (String): 사용자가 제공한 카탈로그 이름입니다.
예
# catalog api function call
Catalog.unmount_catalog('CATALOG_DELTA_SHARING_1')
출력
'{ "unmounted": true }'

반환 유형

JSON 문자열입니다.

반품 구조
'{ "unmounted": operation status (true | false)}'

오류 유형

JSON 문자열

오류 구조

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

카탈로그 테이블 미리보기 프로시저

이 기능은 Oracle Data Studio 카탈로그 테이블을 미리 봅니다.

구문

Catalog.preview_catalog_table(catalog_name, table_name, schema_name,
    row_limit)
매개변수:
  • catalog_name (String): 카탈로그 이름을 지정합니다.
  • table_name (String): 카탈로그 테이블 이름을 지정합니다.
  • schema_name(문자열): 카탈로그 스키마 이름을 지정합니다.
  • row_limit(숫자): 카탈로그 테이블 미리보기 행 제한을 지정합니다. 이 매개변수는 요청 시 사용자가 제공할 필요가 없으며, 이 매개변수를 생략할 경우 시스템에서 자동으로 기본값 100를 사용합니다.
예
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)

출력


아래 preview-catalog.png에 대한 설명입니다.
preview-catalog.png에 대한 설명

반환 유형

JSON 문자열입니다.

반품 구조
'[{"columnName": "row_value",.. }, {}, ...]'

오류 유형

JSON 문자열

오류 구조

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

OCI 데이터 카탈로그 마운트 프로시저

이 함수는 OCI 데이터 카탈로그를 마운트합니다.

구문

Catalog.mount_oci_data_catalog(catalog_name, oci_catalog_credential, oci_catalog_region, oci_catalog_name, oci_storage_credential)
매개변수:
  • catalog_name (String): 카탈로그 이름을 지정합니다.
  • oci_catalog_credential(문자열): OCI 카탈로그 인증서를 지정합니다.
  • oci_catalog_region(문자열): OCI 카탈로그 영역을 지정합니다.
  • oci_catalog_name(문자열): OCI 카탈로그 이름을 지정합니다.
  • oci_storage_credential(문자열): OCI 스토리지 인증서를 지정합니다. 이 매개변수는 요청 시 사용자가 제공할 필요가 없으며, 이 매개변수를 생략할 경우 시스템에서 자동으로 기본값 None를 사용합니다.

반환 유형

JSON 문자열입니다.

반품 구조
'[{"catalogName": catalog name (String),
   "shareName": share name (String)}]'

오류 유형

JSON 문자열

오류 구조

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

Autonomous Database 공유 카탈로그 마운트 프로시저

이 기능은 자율운영 데이터베이스 공유 카탈로그를 마운트합니다.

구문

Catalog.mount_autonomous_database_catalog(catalog_name, database_name, create_database_link,
      database_link_name, credential_name)
매개변수:
  • catalog_name (String): 카탈로그 이름을 지정합니다.
  • database_name(문자열): 자율운영 데이터베이스 이름을 지정합니다.
  • create_database_link (부울): 데이터베이스 링크 이름 모드를 생성합니다. 이 매개변수는 요청 시 사용자가 제공할 필요가 없으며, 이 매개변수를 생략할 경우 시스템에서 자동으로 기본값 False를 사용합니다.
  • database_link_name(문자열): 데이터베이스 링크 이름입니다. 이 매개변수는 요청 시 사용자가 제공할 필요가 없으며, 이 매개변수를 생략할 경우 시스템에서 자동으로 기본값 False를 사용합니다.
  • credential_name(문자열): 신속한 인증서 이름입니다. 이 매개변수는 요청 시 사용자가 제공할 필요가 없으며, 이 매개변수를 생략할 경우 시스템에서 자동으로 기본값 False를 사용합니다.

반환 유형

JSON 문자열입니다.

반품 구조
'[{"catalogName": catalog name (String),
   "shareName": share name (String)}]'

오류 유형

JSON 문자열

오류 구조

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

마운트 공유 카탈로그 프로시저

이 기능은 Oracle Data Studio 공유 카탈로그를 마운트합니다.

구문

Catalog.mount_shares_catalog(catalog_name, share_name,
    share_provider)
매개변수:
  • catalog_name (String): 카탈로그 이름을 지정합니다.
  • share_name (String): 공유 이름입니다.
  • share_provider (String): 공유 공급자 이름입니다.
예
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')
출력
'[{"catalogName":"CATALOG_DELTA_SHARING_1","shareName":"DELTA_SHARING"}]'

반환 유형

JSON 문자열입니다.

반품 구조
'[{"catalogName": catalog name (String),
"shareName": share name (String)}]'

오류 유형

JSON 문자열

오류 구조

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

상위 항목: Autonomous Database용 Python Data Studio API 작업