watsonx.data | IBM Cloud API Docs

Introduction

Last updated: 2023-07-10

IBM® watsonx.data is a data management solution for collecting, storing, querying, and analyzing all your enterprise data (structured, semi-structured, and unstructured) with a single unified data platform. It provides a flexible and reliable platform that is optimized to work on open data formats.

The api are in beta state and expected to change.

Endpoint URLs

The base URLs come from the service instance. To find the URL, view the service credentials by clicking the name of the service in the Resource list. Use the value of the URL. Add the method to form the complete API endpoint for your request.

Authentication

Required Purpose: To work with the API, you must use an IBM Cloud Identity and Access Management (IAM) access token. The token is used to determine the actions that a user or service ID has access to when they use the API.

You can generate an IAM token for an authenticated user or service ID by using the IAM Identity Services API. IAM tokens are generated by using the user or service ID's API key. For more information, see Generating an IBM Cloud IAM token by using an API key.

To use the API, add a valid IAM token to the HTTP Authorization request header, for example, -H 'Authorization: Bearer {TOKEN}'.

To retrieve your access token:

curl -X POST   "https://iam.cloud.ibm.com/identity/token"   --header 'Content-Type: application/x-www-form-urlencoded'   --header 'Accept: application/json'   --data-urlencode 'grant_type=urn:ibm:params:oauth:grant-type:apikey'   --data-urlencode 'apikey={API_KEY}'

Replace {API_KEY} with your IAM API key.

Auditing

Required if applicable Purpose: Describes that the API generates auditing events that can be consumed by the Activity Tracker service, and links to your related product docs for more information. Required only if any of the API's methods is enabled to generate auditing events.

Example:

You can monitor API activity within your account by using the IBM Cloud Activity Tracker service. Whenever an API method is called, an event is generated that you can then track and audit from within Activity Tracker. The specific event type is listed for each individual method.

For more information about how to track Certificate Manager activity, see Auditing events for Certificate Manager.

Error handling

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response indicates success. A 400 type response indicates a failure, and a 500 type response indicates an internal system error.

HTTP Error Code	Description	Recovery
`200`	Success	The request was successful.
`201`	Created	The requested resource successfully created in a synchronous manner.
`204`	No Content	The server successfully processed the request and is not returning any content.
`400`	Bad Request	The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request.
`401`	Unauthorized	You are not authorized to make this request. Log in to IBM Cloud and try again. If this error persists, contact the account owner to check your permissions.
`403`	Forbidden	The supplied authentication is not authorized to access '{namespace}'.
`404`	Not Found	The requested resource could not be found.
`409`	Conflict	The entity is already in the requested state.
`500`	Internal Server Error	Your request could not be processed. Wait a few minutes and try again.

Pagination

Some API requests might return many results. To avoid performance issues, these results are returned one page at a time, with a limited number of results on each page. GET requests for the following resources use pagination:

/v1/statement

For the request that uses pagination, the response does include following urls to make subsequent requests :

infoUri: The URL for requesting the first page of results.
nextUri: The URL for requesting the next page of results.

Get list of registered buckets

Get list of registered buckets.

GET /bucket_registrations

(watsonxData *WatsonxDataV2) ListBucketRegistrations(listBucketRegistrationsOptions *ListBucketRegistrationsOptions) (result *BucketRegistrationCollection, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) ListBucketRegistrationsWithContext(ctx context.Context, listBucketRegistrationsOptions *ListBucketRegistrationsOptions) (result *BucketRegistrationCollection, response *core.DetailedResponse, err error)

ServiceCall<BucketRegistrationCollection> listBucketRegistrations(ListBucketRegistrationsOptions listBucketRegistrationsOptions)

list_bucket_registrations(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

listBucketRegistrations(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.bucket_registration.list

Request

Instantiate the ListBucketRegistrationsOptions struct and set the fields to provide parameter values for the ListBucketRegistrations method.

Use the ListBucketRegistrationsOptions.Builder to create a ListBucketRegistrationsOptions object that contains the parameter values for the listBucketRegistrations method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

parameter

WithContext method only

ListBucketRegistrationsOptions

The ListBucketRegistrations options.

ListBucketRegistrationsOptions

The listBucketRegistrations options.

parameters

auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X GET -H "accept: application/json" -H "AuthInstanceId: {instance_id}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/bucket_registrations"

Example request

let res;
try {
  res = await watsonxDataService.listBucketRegistrations({});
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

ListBucketRegistrationsOptions listBucketRegistrationsOptions = new ListBucketRegistrationsOptions.Builder()
  .build();

Response<BucketRegistrationCollection> response = watsonxDataService.listBucketRegistrations(listBucketRegistrationsOptions).execute();
BucketRegistrationCollection bucketRegistrationCollection = response.getResult();

System.out.println(bucketRegistrationCollection);

Example request

response = watsonx_data_service.list_bucket_registrations()
bucket_registration_collection = response.get_result()

print(json.dumps(bucket_registration_collection, indent=2))

Response

Response Body

BucketRegistrationCollection

List bucket registrations

BucketRegistrationCollection

List bucket registrations.

Examples:

View

BucketRegistrationCollection

List bucket registrations.

Examples:

View

BucketRegistrationCollection

List bucket registrations.

Examples:

View

BucketRegistrationCollection

List bucket registrations.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "bucket_registrations": [
    {
      "actions": [
        "browse",
        "view",
        "modify",
        "create",
        "grant",
        "revoke",
        "update",
        "remove",
        "activate",
        "register"
      ],
      "associated_catalog": {
        "catalog_name": "iceberg_catalog",
        "catalog_tags": []
      },
      "bucket_details": {
        "bucket_name": "iceberg-bucket",
        "endpoint": "http://xyz-minio-svc:9000"
      },
      "bucket_display_name": "hive-bucket",
      "bucket_id": "iceberg-bucket",
      "bucket_type": "minio",
      "created_by": "user",
      "created_on": "1699457595",
      "description": "default bucket",
      "managed_by": "ibm",
      "region": "us-south",
      "state": "active",
      "tags": [
        "tag1",
        "tag2"
      ]
    },
    {
      "actions": [
        "browse",
        "view",
        "modify",
        "create",
        "grant",
        "revoke",
        "update",
        "remove",
        "activate",
        "register"
      ],
      "associated_catalog": {
        "catalog_name": "hive_data",
        "catalog_tags": []
      },
      "bucket_details": {
        "bucket_name": "hive-bucket",
        "endpoint": "http://xyz-minio-svc:9000"
      },
      "bucket_display_name": "hive-bucket",
      "bucket_id": "hive-bucket",
      "bucket_type": "minio",
      "created_by": "user",
      "created_on": "1699457595",
      "description": "default bucket",
      "managed_by": "ibm",
      "region": "us-south",
      "state": "active",
      "tags": [
        "tag1",
        "tag2"
      ]
    }
  ]
}

Success example

{
  "bucket_registrations": [
    {
      "actions": [
        "browse",
        "view",
        "modify",
        "create",
        "grant",
        "revoke",
        "update",
        "remove",
        "activate",
        "register"
      ],
      "associated_catalog": {
        "catalog_name": "iceberg_catalog",
        "catalog_tags": []
      },
      "bucket_details": {
        "bucket_name": "iceberg-bucket",
        "endpoint": "http://xyz-minio-svc:9000"
      },
      "bucket_display_name": "hive-bucket",
      "bucket_id": "iceberg-bucket",
      "bucket_type": "minio",
      "created_by": "user",
      "created_on": "1699457595",
      "description": "default bucket",
      "managed_by": "ibm",
      "region": "us-south",
      "state": "active",
      "tags": [
        "tag1",
        "tag2"
      ]
    },
    {
      "actions": [
        "browse",
        "view",
        "modify",
        "create",
        "grant",
        "revoke",
        "update",
        "remove",
        "activate",
        "register"
      ],
      "associated_catalog": {
        "catalog_name": "hive_data",
        "catalog_tags": []
      },
      "bucket_details": {
        "bucket_name": "hive-bucket",
        "endpoint": "http://xyz-minio-svc:9000"
      },
      "bucket_display_name": "hive-bucket",
      "bucket_id": "hive-bucket",
      "bucket_type": "minio",
      "created_by": "user",
      "created_on": "1699457595",
      "description": "default bucket",
      "managed_by": "ibm",
      "region": "us-south",
      "state": "active",
      "tags": [
        "tag1",
        "tag2"
      ]
    }
  ]
}

Register a new bucket

Register a new bucket.

POST /bucket_registrations

(watsonxData *WatsonxDataV2) CreateBucketRegistration(createBucketRegistrationOptions *CreateBucketRegistrationOptions) (result *BucketRegistration, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) CreateBucketRegistrationWithContext(ctx context.Context, createBucketRegistrationOptions *CreateBucketRegistrationOptions) (result *BucketRegistration, response *core.DetailedResponse, err error)

ServiceCall<BucketRegistration> createBucketRegistration(CreateBucketRegistrationOptions createBucketRegistrationOptions)

create_bucket_registration(
        self,
        bucket_details: 'BucketDetails',
        bucket_type: str,
        description: str,
        managed_by: str,
        *,
        associated_catalog: Optional['BucketCatalog'] = None,
        bucket_display_name: Optional[str] = None,
        region: Optional[str] = None,
        tags: Optional[List[str]] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

createBucketRegistration(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.bucket_registration.create

Request

Instantiate the CreateBucketRegistrationOptions struct and set the fields to provide parameter values for the CreateBucketRegistration method.

Use the CreateBucketRegistrationOptions.Builder to create a CreateBucketRegistrationOptions object that contains the parameter values for the createBucketRegistration method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Request Body

Required*

BucketRegistrationPrototype

Request body

parameter

WithContext method only

CreateBucketRegistrationOptions

The CreateBucketRegistration options.

CreateBucketRegistrationOptions

The createBucketRegistration options.

parameters

bucket_details
bucket details.
bucket_type
Required*
str
bucket type.

Allowable values: [aws_s3,minio,ibm_cos,ibm_ceph]
Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
Examples:
value
_source
_lines
_html
description
Required*
str
bucket description.

Possible values: 0 ≤ length ≤ 10000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
managed_by
Required*
str
managed by.

Allowable values: [ibm,customer]
Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9.@<>\\-]+/
Examples:
value
_source
_lines
_html
associated_catalog
bucket catalog.

Examples:
View
bucket_display_name
str
bucket display name.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
region
str
region where the bucket is located.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
tags
List[str]
tags.

Possible values: 0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 1024, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

bucketDetails
bucket details.
bucketType
Required*
string
bucket type.

Allowable values: [aws_s3,minio,ibm_cos,ibm_ceph]
Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
Examples:
value
_source
_lines
_html
description
Required*
string
bucket description.

Possible values: 0 ≤ length ≤ 10000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
managedBy
Required*
string
managed by.

Allowable values: [ibm,customer]
Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9.@<>\\-]+/
Examples:
value
_source
_lines
_html
associatedCatalog
bucket catalog.

Examples:
View
bucketDisplayName
string
bucket display name.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
region
string
region where the bucket is located.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
tags
string[]
tags.

Possible values: 0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 1024, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X POST -H "accept: application/json" -H "AuthInstanceId: {instance_id}" -H "Content-Type: application/json" -d '{ "bucket_details": { "access_key": "<access_key>", "bucket_name": "sample-bucket", "endpoint": "https://s3.{region}.cloud-object-storage.appdomain.cloud/", "secret_key": "secret_key" }, "bucket_display_name": "sample-bucket-displayname", "bucket_tags": [ "read customer data", "write customer data'" ], "bucket_type": "ibm_cos", "catalog_name": "sampleCatalog", "catalog_tags": [ "catalog_tag_1", "catalog_tag_2" ], "description": "COS bucket for customer data", "managed_by": "ibm", "region": "us-south", "state": "active", "table_type": "iceberg" }' "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/bucket_registrations"

Example request

// Request models needed by this operation.

// BucketDetails
const bucketDetailsModel = {
  bucket_name: 'sample-bucket',
};

const params = {
  bucketDetails: bucketDetailsModel,
  bucketType: 'ibm_cos',
  description: 'COS bucket for customer data',
  managedBy: 'ibm',
};

let res;
try {
  res = await watsonxDataService.createBucketRegistration(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

BucketDetails bucketDetailsModel = new BucketDetails.Builder()
  .bucketName("sample-bucket")
  .build();
CreateBucketRegistrationOptions createBucketRegistrationOptions = new CreateBucketRegistrationOptions.Builder()
  .bucketDetails(bucketDetailsModel)
  .bucketType("ibm_cos")
  .description("COS bucket for customer data")
  .managedBy("ibm")
  .build();

Response<BucketRegistration> response = watsonxDataService.createBucketRegistration(createBucketRegistrationOptions).execute();
BucketRegistration bucketRegistration = response.getResult();

System.out.println(bucketRegistration);

Example request

bucket_details_model = {
  'bucket_name': 'sample-bucket',
}

response = watsonx_data_service.create_bucket_registration(
  bucket_details=bucket_details_model,
  bucket_type='ibm_cos',
  description='COS bucket for customer data',
  managed_by='ibm',
)
bucket_registration = response.get_result()

print(json.dumps(bucket_registration, indent=2))

Response

Response Body

BucketRegistration

Bucket

BucketRegistration

Bucket.

Examples:

View

BucketRegistration

Bucket.

Examples:

View

BucketRegistration

Bucket.

Examples:

View

BucketRegistration

Bucket.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}

Success example

{
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}

Get a registered bucket

Get a registered bucket.

GET /bucket_registrations/{bucket_id}

(watsonxData *WatsonxDataV2) GetBucketRegistration(getBucketRegistrationOptions *GetBucketRegistrationOptions) (result *BucketRegistration, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) GetBucketRegistrationWithContext(ctx context.Context, getBucketRegistrationOptions *GetBucketRegistrationOptions) (result *BucketRegistration, response *core.DetailedResponse, err error)

ServiceCall<BucketRegistration> getBucketRegistration(GetBucketRegistrationOptions getBucketRegistrationOptions)

get_bucket_registration(
        self,
        bucket_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

getBucketRegistration(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.bucket_registration.get

Request

Instantiate the GetBucketRegistrationOptions struct and set the fields to provide parameter values for the GetBucketRegistration method.

Use the GetBucketRegistrationOptions.Builder to create a GetBucketRegistrationOptions object that contains the parameter values for the getBucketRegistration method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

bucket_id
Required*
string
bucket id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

GetBucketRegistrationOptions

The GetBucketRegistration options.

GetBucketRegistrationOptions

The getBucketRegistration options.

parameters

bucket_id
Required*
str
bucket id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

bucketId
Required*
string
bucket id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X GET -H "accept: application/json" -H "AuthInstanceId: {instance_id}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/bucket_registrations/{bucket_id}"

Example request

const params = {
  bucketId: 'testString',
};

let res;
try {
  res = await watsonxDataService.getBucketRegistration(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

GetBucketRegistrationOptions getBucketRegistrationOptions = new GetBucketRegistrationOptions.Builder()
  .bucketId("testString")
  .build();

Response<BucketRegistration> response = watsonxDataService.getBucketRegistration(getBucketRegistrationOptions).execute();
BucketRegistration bucketRegistration = response.getResult();

System.out.println(bucketRegistration);

Example request

response = watsonx_data_service.get_bucket_registration(
  bucket_id='testString',
)
bucket_registration = response.get_result()

print(json.dumps(bucket_registration, indent=2))

Response

Response Body

BucketRegistration

Bucket

BucketRegistration

Bucket.

Examples:

View

BucketRegistration

Bucket.

Examples:

View

BucketRegistration

Bucket.

Examples:

View

BucketRegistration

Bucket.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}

Success example

{
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}

Unregister a bucket

Unregister a bucket.

DELETE /bucket_registrations/{bucket_id}

(watsonxData *WatsonxDataV2) DeleteBucketRegistration(deleteBucketRegistrationOptions *DeleteBucketRegistrationOptions) (response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) DeleteBucketRegistrationWithContext(ctx context.Context, deleteBucketRegistrationOptions *DeleteBucketRegistrationOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> deleteBucketRegistration(DeleteBucketRegistrationOptions deleteBucketRegistrationOptions)

delete_bucket_registration(
        self,
        bucket_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

deleteBucketRegistration(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.bucket_registration.delete

Request

Instantiate the DeleteBucketRegistrationOptions struct and set the fields to provide parameter values for the DeleteBucketRegistration method.

Use the DeleteBucketRegistrationOptions.Builder to create a DeleteBucketRegistrationOptions object that contains the parameter values for the deleteBucketRegistration method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

bucket_id
Required*
string
bucket id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

DeleteBucketRegistrationOptions

The DeleteBucketRegistration options.

DeleteBucketRegistrationOptions

The deleteBucketRegistration options.

parameters

bucket_id
Required*
str
bucket id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

bucketId
Required*
string
bucket id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X DELETE -H "accept:  */*" -H "AuthInstanceId: {instance_id}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/bucket_registrations/{bucket_id}"

Example request

const params = {
  bucketId: 'testString',
};

try {
  await watsonxDataService.deleteBucketRegistration(params);
} catch (err) {
  console.warn(err);
}

Example request

DeleteBucketRegistrationOptions deleteBucketRegistrationOptions = new DeleteBucketRegistrationOptions.Builder()
  .bucketId("testString")
  .build();

Response<Void> response = watsonxDataService.deleteBucketRegistration(deleteBucketRegistrationOptions).execute();

Example request

response = watsonx_data_service.delete_bucket_registration(
  bucket_id='testString',
)

Response

Status Code

204
No Content
400
Error
401
Unauthorized
404
Not found
500
Internal server error

No Sample Response

This method does not specify any sample responses.

Update bucket details & credentials

Update bucket details & credentials.

PATCH /bucket_registrations/{bucket_id}

(watsonxData *WatsonxDataV2) UpdateBucketRegistration(updateBucketRegistrationOptions *UpdateBucketRegistrationOptions) (result *BucketRegistration, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) UpdateBucketRegistrationWithContext(ctx context.Context, updateBucketRegistrationOptions *UpdateBucketRegistrationOptions) (result *BucketRegistration, response *core.DetailedResponse, err error)

ServiceCall<BucketRegistration> updateBucketRegistration(UpdateBucketRegistrationOptions updateBucketRegistrationOptions)

update_bucket_registration(
        self,
        bucket_id: str,
        body: List['JsonPatchOperation'],
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

updateBucketRegistration(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.bucket_registration.update

Request

Instantiate the UpdateBucketRegistrationOptions struct and set the fields to provide parameter values for the UpdateBucketRegistration method.

Use the UpdateBucketRegistrationOptions.Builder to create a UpdateBucketRegistrationOptions object that contains the parameter values for the updateBucketRegistration method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

bucket_id
Required*
string
bucket id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

Request Body

Required*

application/json-patch+jsonBucketRegistrationPatch

Request body

Examples:

View

parameter

WithContext method only

UpdateBucketRegistrationOptions

The UpdateBucketRegistration options.

UpdateBucketRegistrationOptions

The updateBucketRegistration options.

parameters

bucket_id
Required*
str
bucket id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
body
Required*
List[JsonPatchOperation]
Request body.
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

bucketId
Required*
string
bucket id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
body
Required*
JsonPatchOperation[]
Request body.
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X PATCH -H "accept: application/json" -H "AuthInstanceId: {instance_id}" -H "Content-Type: application/json" -d '{ "access_key": "<access_key>", "bucket_display_name": "sample-bucket-displayname", "description": "COS bucket for customer data", "secret_key": "<secret_key>", "tags": [ "testbucket", "userbucket" ] }' "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/bucket_registrations/{bucket_id}"

Example request

// Request models needed by this operation.

// JsonPatchOperation
const jsonPatchOperationModel = {
  op: 'add',
  path: 'testString',
};

const params = {
  bucketId: 'testString',
  body: [jsonPatchOperationModel],
};

let res;
try {
  res = await watsonxDataService.updateBucketRegistration(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

JsonPatchOperation jsonPatchOperationModel = new JsonPatchOperation.Builder()
  .op("add")
  .path("testString")
  .build();
UpdateBucketRegistrationOptions updateBucketRegistrationOptions = new UpdateBucketRegistrationOptions.Builder()
  .bucketId("testString")
  .body(java.util.Arrays.asList(jsonPatchOperationModel))
  .build();

Response<BucketRegistration> response = watsonxDataService.updateBucketRegistration(updateBucketRegistrationOptions).execute();
BucketRegistration bucketRegistration = response.getResult();

System.out.println(bucketRegistration);

Example request

json_patch_operation_model = {
  'op': 'add',
  'path': 'testString',
}

response = watsonx_data_service.update_bucket_registration(
  bucket_id='testString',
  body=[json_patch_operation_model],
)
bucket_registration = response.get_result()

print(json.dumps(bucket_registration, indent=2))

Response

Response Body

BucketRegistration

Bucket

BucketRegistration

Bucket.

Examples:

View

BucketRegistration

Bucket.

Examples:

View

BucketRegistration

Bucket.

Examples:

View

BucketRegistration

Bucket.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}

Success example

{
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}

Activate a registered bucket

Activate a registered bucket.

POST /bucket_registrations/{bucket_id}/activate

(watsonxData *WatsonxDataV2) CreateActivateBucket(createActivateBucketOptions *CreateActivateBucketOptions) (result *CreateActivateBucketCreatedBody, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) CreateActivateBucketWithContext(ctx context.Context, createActivateBucketOptions *CreateActivateBucketOptions) (result *CreateActivateBucketCreatedBody, response *core.DetailedResponse, err error)

ServiceCall<CreateActivateBucketCreatedBody> createActivateBucket(CreateActivateBucketOptions createActivateBucketOptions)

create_activate_bucket(
        self,
        bucket_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

createActivateBucket(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.bucket_registration_activate.add

Request

Instantiate the CreateActivateBucketOptions struct and set the fields to provide parameter values for the CreateActivateBucket method.

Use the CreateActivateBucketOptions.Builder to create a CreateActivateBucketOptions object that contains the parameter values for the createActivateBucket method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

bucket_id
Required*
string
bucket id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

CreateActivateBucketOptions

The CreateActivateBucket options.

CreateActivateBucketOptions

The createActivateBucket options.

parameters

bucket_id
Required*
str
bucket id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

bucketId
Required*
string
bucket id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X POST -H "accept: application/json" -H "AuthInstanceId: {instance_id}" -d "" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/bucket_registrations/{bucket_id}/activate"

Example request

const params = {
  bucketId: 'testString',
};

let res;
try {
  res = await watsonxDataService.createActivateBucket(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

CreateActivateBucketOptions createActivateBucketOptions = new CreateActivateBucketOptions.Builder()
  .bucketId("testString")
  .build();

Response<CreateActivateBucketCreatedBody> response = watsonxDataService.createActivateBucket(createActivateBucketOptions).execute();
CreateActivateBucketCreatedBody createActivateBucketCreatedBody = response.getResult();

System.out.println(createActivateBucketCreatedBody);

Example request

response = watsonx_data_service.create_activate_bucket(
  bucket_id='testString',
)
create_activate_bucket_created_body = response.get_result()

print(json.dumps(create_activate_bucket_created_body, indent=2))

Response

Response Body

CreateActivateBucketCreatedBody

Activate bucket

CreateActivateBucketCreatedBody

Activate bucket.

Examples:

View

CreateActivateBucketCreatedBody

Activate bucket.

Examples:

View

CreateActivateBucketCreatedBody

Activate bucket.

Examples:

View

CreateActivateBucketCreatedBody

Activate bucket.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "response": {
    "message": "Activate bucket",
    "message_code": "success"
  }
}

Success example

{
  "response": {
    "message": "Activate bucket",
    "message_code": "success"
  }
}

Deactivate a bucket

Deactivate a bucket.

DELETE /bucket_registrations/{bucket_id}/deactivate

(watsonxData *WatsonxDataV2) DeleteDeactivateBucket(deleteDeactivateBucketOptions *DeleteDeactivateBucketOptions) (response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) DeleteDeactivateBucketWithContext(ctx context.Context, deleteDeactivateBucketOptions *DeleteDeactivateBucketOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> deleteDeactivateBucket(DeleteDeactivateBucketOptions deleteDeactivateBucketOptions)

delete_deactivate_bucket(
        self,
        bucket_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

deleteDeactivateBucket(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.bucket_registration_activate.remove

Request

Instantiate the DeleteDeactivateBucketOptions struct and set the fields to provide parameter values for the DeleteDeactivateBucket method.

Use the DeleteDeactivateBucketOptions.Builder to create a DeleteDeactivateBucketOptions object that contains the parameter values for the deleteDeactivateBucket method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

bucket_id
Required*
string
bucket id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

DeleteDeactivateBucketOptions

The DeleteDeactivateBucket options.

DeleteDeactivateBucketOptions

The deleteDeactivateBucket options.

parameters

bucket_id
Required*
str
bucket id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

bucketId
Required*
string
bucket id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X DELETE -H "accept: */*" -H "AuthInstanceId: {instance_id}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/bucket_registrations/{bucket_id}/deactivate"

Example request

const params = {
  bucketId: 'testString',
};

try {
  await watsonxDataService.deleteDeactivateBucket(params);
} catch (err) {
  console.warn(err);
}

Example request

DeleteDeactivateBucketOptions deleteDeactivateBucketOptions = new DeleteDeactivateBucketOptions.Builder()
  .bucketId("testString")
  .build();

Response<Void> response = watsonxDataService.deleteDeactivateBucket(deleteDeactivateBucketOptions).execute();

Example request

response = watsonx_data_service.delete_deactivate_bucket(
  bucket_id='testString',
)

Response

Status Code

204
No Content
400
Error
401
Unauthorized
404
Not found
500
Internal server error

No Sample Response

This method does not specify any sample responses.

Fetch all objects from a given bucket

Fetch all objects from a given bucket.

GET /bucket_registrations/{bucket_id}/objects

(watsonxData *WatsonxDataV2) ListBucketObjects(listBucketObjectsOptions *ListBucketObjectsOptions) (result *BucketRegistrationObjectCollection, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) ListBucketObjectsWithContext(ctx context.Context, listBucketObjectsOptions *ListBucketObjectsOptions) (result *BucketRegistrationObjectCollection, response *core.DetailedResponse, err error)

ServiceCall<BucketRegistrationObjectCollection> listBucketObjects(ListBucketObjectsOptions listBucketObjectsOptions)

list_bucket_objects(
        self,
        bucket_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

listBucketObjects(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.bucket_registration_object.list

Request

Instantiate the ListBucketObjectsOptions struct and set the fields to provide parameter values for the ListBucketObjects method.

Use the ListBucketObjectsOptions.Builder to create a ListBucketObjectsOptions object that contains the parameter values for the listBucketObjects method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

bucket_id
Required*
string
bucket id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

ListBucketObjectsOptions

The ListBucketObjects options.

ListBucketObjectsOptions

The listBucketObjects options.

parameters

bucket_id
Required*
str
bucket id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

bucketId
Required*
string
bucket id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X GET -H "accept: application/json" -H "AuthInstanceId: {instance_id}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/bucket_registrations/{bucket_id}/objects"

Example request

const params = {
  bucketId: 'testString',
};

let res;
try {
  res = await watsonxDataService.listBucketObjects(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

ListBucketObjectsOptions listBucketObjectsOptions = new ListBucketObjectsOptions.Builder()
  .bucketId("testString")
  .build();

Response<BucketRegistrationObjectCollection> response = watsonxDataService.listBucketObjects(listBucketObjectsOptions).execute();
BucketRegistrationObjectCollection bucketRegistrationObjectCollection = response.getResult();

System.out.println(bucketRegistrationObjectCollection);

Example request

response = watsonx_data_service.list_bucket_objects(
  bucket_id='testString',
)
bucket_registration_object_collection = response.get_result()

print(json.dumps(bucket_registration_object_collection, indent=2))

Response

Response Body

BucketRegistrationObjectCollection

List bucket objects

BucketRegistrationObjectCollection

List bucket objects.

Examples:

View

BucketRegistrationObjectCollection

List bucket objects.

Examples:

View

BucketRegistrationObjectCollection

List bucket objects.

Examples:

View

BucketRegistrationObjectCollection

List bucket objects.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "objects": [
    "/path/file1.json",
    "/path/file2.txt",
    "/path/file3.csv",
    "/path/file4.parquet"
  ]
}

Success example

{
  "objects": [
    "/path/file1.json",
    "/path/file2.txt",
    "/path/file3.csv",
    "/path/file4.parquet"
  ]
}

Check whether provided bucket credentials are valid or not

Check whether provided bucket credentials are valid or not.

POST /test_bucket_connection

(watsonxData *WatsonxDataV2) TestBucketConnection(testBucketConnectionOptions *TestBucketConnectionOptions) (result *TestBucketConnectionOKBody, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) TestBucketConnectionWithContext(ctx context.Context, testBucketConnectionOptions *TestBucketConnectionOptions) (result *TestBucketConnectionOKBody, response *core.DetailedResponse, err error)

ServiceCall<TestBucketConnectionOKBody> testBucketConnection(TestBucketConnectionOptions testBucketConnectionOptions)

test_bucket_connection(
        self,
        access_key: str,
        bucket_name: str,
        bucket_type: str,
        endpoint: str,
        region: str,
        secret_key: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

testBucketConnection(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.test_bucket_connection.evaluate

Request

Instantiate the TestBucketConnectionOptions struct and set the fields to provide parameter values for the TestBucketConnection method.

Use the TestBucketConnectionOptions.Builder to create a TestBucketConnectionOptions object that contains the parameter values for the testBucketConnection method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Request Body

Required*

CheckBucketCredentialsBody

Check if given credentials for the bucket are valid

parameter

WithContext method only

TestBucketConnectionOptions

The TestBucketConnection options.

TestBucketConnectionOptions

The testBucketConnection options.

parameters

access_key
Required*
str
access key to access the bucket.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9.@<>\\-]+/
Examples:
value
_source
_lines
_html
bucket_name
Required*
str
name of the bucket to be checked.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
Examples:
value
_source
_lines
_html
bucket_type
Required*
str
type of bucket that is selected.

Allowable values: [amazon_s3,aws_s3,minio,ibm_cos,ibm_ceph]
Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
endpoint
Required*
str
endpoint to reach the bucket.

Possible values: 1 ≤ length ≤ 1024, Value must match regular expression /^[a-zA-Z0-9\\-:\/@?=.]+/
Examples:
value
_source
_lines
_html
region
Required*
str
bucket region.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
secret_key
Required*
str
secret key to access the bucket.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9.@<>\\-]+/
Examples:
value
_source
_lines
_html
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

accessKey
Required*
string
access key to access the bucket.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9.@<>\\-]+/
Examples:
value
_source
_lines
_html
bucketName
Required*
string
name of the bucket to be checked.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
Examples:
value
_source
_lines
_html
bucketType
Required*
string
type of bucket that is selected.

Allowable values: [amazon_s3,aws_s3,minio,ibm_cos,ibm_ceph]
Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
endpoint
Required*
string
endpoint to reach the bucket.

Possible values: 1 ≤ length ≤ 1024, Value must match regular expression /^[a-zA-Z0-9\\-:\/@?=.]+/
Examples:
value
_source
_lines
_html
region
Required*
string
bucket region.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
secretKey
Required*
string
secret key to access the bucket.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9.@<>\\-]+/
Examples:
value
_source
_lines
_html
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X POST -H "accept: application/json" -H "AuthInstanceId: {instance_id}" -H "Content-Type: application/json" -d '{ "access_key": "<access_key>", "bucket_name": "sample-bucket", "bucket_type": "ibm_cos", "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/", "region": "us-south", "secret_key": "<secret_key>" }' "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/test_bucket_connection"

Example request

const params = {
  accessKey: '<access_key>',
  bucketName: 'sample-bucket',
  bucketType: 'ibm_cos',
  endpoint: 'https://s3.<region>.cloud-object-storage.appdomain.cloud/',
  region: 'us-south',
  secretKey: 'secret_key',
};

let res;
try {
  res = await watsonxDataService.testBucketConnection(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

TestBucketConnectionOptions testBucketConnectionOptions = new TestBucketConnectionOptions.Builder()
  .accessKey("<access_key>")
  .bucketName("sample-bucket")
  .bucketType("ibm_cos")
  .endpoint("https://s3.<region>.cloud-object-storage.appdomain.cloud/")
  .region("us-south")
  .secretKey("secret_key")
  .build();

Response<TestBucketConnectionOKBody> response = watsonxDataService.testBucketConnection(testBucketConnectionOptions).execute();
TestBucketConnectionOKBody testBucketConnectionOkBody = response.getResult();

System.out.println(testBucketConnectionOkBody);

Example request

response = watsonx_data_service.test_bucket_connection(
  access_key='<access_key>',
  bucket_name='sample-bucket',
  bucket_type='ibm_cos',
  endpoint='https://s3.<region>.cloud-object-storage.appdomain.cloud/',
  region='us-south',
  secret_key='secret_key',
)
test_bucket_connection_ok_body = response.get_result()

print(json.dumps(test_bucket_connection_ok_body, indent=2))

Response

Response Body

TestBucketConnectionOKBody

ValidateBucketRegistrationCredentials OK

TestBucketConnectionOKBody

ValidateBucketRegistrationCredentials OK.

Examples:

View

TestBucketConnectionOKBody

ValidateBucketRegistrationCredentials OK.

Examples:

View

TestBucketConnectionOKBody

ValidateBucketRegistrationCredentials OK.

Examples:

View

TestBucketConnectionOKBody

ValidateBucketRegistrationCredentials OK.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal Server Error

Example responses

Status 200

{
  "bucket_status": {
    "state": true,
    "state_message": "Credentials provided for <bucket-name> bucket are correct."
  },
  "response": {
    "message": "Test bucket connection",
    "message_code": "success"
  }
}

Success example

{
  "bucket_status": {
    "state": true,
    "state_message": "Credentials provided for <bucket-name> bucket are correct."
  },
  "response": {
    "message": "Test bucket connection",
    "message_code": "success"
  }
}

Add or create a new database with driver

Add or create a new database with driver.

POST /database_driver_registrations

(watsonxData *WatsonxDataV2) CreateDriverDatabaseCatalog(createDriverDatabaseCatalogOptions *CreateDriverDatabaseCatalogOptions) (result *DatabaseRegistration, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) CreateDriverDatabaseCatalogWithContext(ctx context.Context, createDriverDatabaseCatalogOptions *CreateDriverDatabaseCatalogOptions) (result *DatabaseRegistration, response *core.DetailedResponse, err error)

ServiceCall<DatabaseRegistration> createDriverDatabaseCatalog(CreateDriverDatabaseCatalogOptions createDriverDatabaseCatalogOptions)

create_driver_database_catalog(
        self,
        driver: BinaryIO,
        driver_file_name: str,
        database_display_name: str,
        database_type: str,
        catalog_name: str,
        hostname: str,
        port: str,
        username: str,
        password: str,
        database_name: str,
        *,
        driver_content_type: Optional[str] = None,
        certificate: Optional[str] = None,
        certificate_extension: Optional[str] = None,
        ssl: Optional[str] = None,
        description: Optional[str] = None,
        created_on: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

createDriverDatabaseCatalog(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.database_driver_registration.create

Request

Instantiate the CreateDriverDatabaseCatalogOptions struct and set the fields to provide parameter values for the CreateDriverDatabaseCatalog method.

Use the CreateDriverDatabaseCatalogOptions.Builder to create a CreateDriverDatabaseCatalogOptions object that contains the parameter values for the createDriverDatabaseCatalog method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Form Parameters

parameter

WithContext method only

CreateDriverDatabaseCatalogOptions

The CreateDriverDatabaseCatalog options.

CreateDriverDatabaseCatalogOptions

The createDriverDatabaseCatalog options.

parameters

curl example

curl -X POST -H "accept: application/json" -H "AuthInstanceId: {instance_id}" -H "Content-Type: multipart/form-data" -F "port = t" -F "driver = " -F "database_display_name = t" -F "ssl = " -F "database_name =" -F "catalog_name =t" -F "hostname =t" -F "username =" -F "created_on =" -F "driver_file_name =" -F "certificate =" -F "certificate_extension =" -F "password =" -F "description =" -F "database_type =t" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/database_driver_registrations"

Example request

const params = {
  driver: Buffer.from('This is a mock file.'),
  driverFileName: 'testString',
  databaseDisplayName: 'testString',
  databaseType: 'testString',
  catalogName: 'testString',
  hostname: 'testString',
  port: 'testString',
  username: 'testString',
  password: 'testString',
  databaseName: 'testString',
};

let res;
try {
  res = await watsonxDataService.createDriverDatabaseCatalog(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

CreateDriverDatabaseCatalogOptions createDriverDatabaseCatalogOptions = new CreateDriverDatabaseCatalogOptions.Builder()
  .driver(new java.io.ByteArrayInputStream("This is a mock file.".getBytes()))
  .driverFileName("testString")
  .databaseDisplayName("testString")
  .databaseType("testString")
  .catalogName("testString")
  .hostname("testString")
  .port("testString")
  .username("testString")
  .password("testString")
  .databaseName("testString")
  .build();

Response<DatabaseRegistration> response = watsonxDataService.createDriverDatabaseCatalog(createDriverDatabaseCatalogOptions).execute();
DatabaseRegistration databaseRegistration = response.getResult();

System.out.println(databaseRegistration);

Example request

response = watsonx_data_service.create_driver_database_catalog(
  driver=io.BytesIO(b'This is a mock file.').getvalue(),
  driver_file_name='testString',
  database_display_name='testString',
  database_type='testString',
  catalog_name='testString',
  hostname='testString',
  port='testString',
  username='testString',
  password='testString',
  database_name='testString',
)
database_registration = response.get_result()

print(json.dumps(database_registration, indent=2))

Response

Response Body

DatabaseRegistration

database registration object

DatabaseRegistration

database registration object.

Examples:

View

DatabaseRegistration

database registration object.

Examples:

View

DatabaseRegistration

database registration object.

Examples:

View

DatabaseRegistration

database registration object.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "actions": [
    "update",
    "delete"
  ],
  "associated_catalog": {
    "catalog_name": "iceberg_data",
    "catalog_type": "iceberg"
  },
  "created_by": "user1@bim.com",
  "created_on": "1686792721",
  "database_details": {
    "database_name": "new_database",
    "hostname": "netezza://abc.efg.com",
    "password": "samplepassword",
    "port": 4353,
    "ssl": true,
    "tables": "netezza_table_name",
    "username": "sampleuser"
  },
  "database_display_name": "new_database",
  "database_id": "new_database_id",
  "database_type": "netezza",
  "description": "Description of the database",
  "tags": [
    "testdatabase",
    "userdatabase"
  ]
}

Success example

{
  "actions": [
    "update",
    "delete"
  ],
  "associated_catalog": {
    "catalog_name": "iceberg_data",
    "catalog_type": "iceberg"
  },
  "created_by": "user1@bim.com",
  "created_on": "1686792721",
  "database_details": {
    "database_name": "new_database",
    "hostname": "netezza://abc.efg.com",
    "password": "samplepassword",
    "port": 4353,
    "ssl": true,
    "tables": "netezza_table_name",
    "username": "sampleuser"
  },
  "database_display_name": "new_database",
  "database_id": "new_database_id",
  "database_type": "netezza",
  "description": "Description of the database",
  "tags": [
    "testdatabase",
    "userdatabase"
  ]
}

Get list of databases

Get list of databases.

GET /database_registrations

(watsonxData *WatsonxDataV2) ListDatabaseRegistrations(listDatabaseRegistrationsOptions *ListDatabaseRegistrationsOptions) (result *DatabaseRegistrationCollection, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) ListDatabaseRegistrationsWithContext(ctx context.Context, listDatabaseRegistrationsOptions *ListDatabaseRegistrationsOptions) (result *DatabaseRegistrationCollection, response *core.DetailedResponse, err error)

ServiceCall<DatabaseRegistrationCollection> listDatabaseRegistrations(ListDatabaseRegistrationsOptions listDatabaseRegistrationsOptions)

list_database_registrations(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

listDatabaseRegistrations(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.database_registration.list

Request

Instantiate the ListDatabaseRegistrationsOptions struct and set the fields to provide parameter values for the ListDatabaseRegistrations method.

Use the ListDatabaseRegistrationsOptions.Builder to create a ListDatabaseRegistrationsOptions object that contains the parameter values for the listDatabaseRegistrations method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

parameter

WithContext method only

ListDatabaseRegistrationsOptions

The ListDatabaseRegistrations options.

ListDatabaseRegistrationsOptions

The listDatabaseRegistrations options.

parameters

auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X GET -H "accept: application/json" -H "AuthInstanceId: {instance_id}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/database_registrations"

Example request

let res;
try {
  res = await watsonxDataService.listDatabaseRegistrations({});
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

ListDatabaseRegistrationsOptions listDatabaseRegistrationsOptions = new ListDatabaseRegistrationsOptions.Builder()
  .build();

Response<DatabaseRegistrationCollection> response = watsonxDataService.listDatabaseRegistrations(listDatabaseRegistrationsOptions).execute();
DatabaseRegistrationCollection databaseRegistrationCollection = response.getResult();

System.out.println(databaseRegistrationCollection);

Example request

response = watsonx_data_service.list_database_registrations()
database_registration_collection = response.get_result()

print(json.dumps(database_registration_collection, indent=2))

Response

Response Body

DatabaseRegistrationCollection

list database registrations

DatabaseRegistrationCollection

list database registrations.

Examples:

View

DatabaseRegistrationCollection

list database registrations.

Examples:

View

DatabaseRegistrationCollection

list database registrations.

Examples:

View

DatabaseRegistrationCollection

list database registrations.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "database_registrations": [
    {
      "actions": [
        "update",
        "delete"
      ],
      "associated_catalog": {
        "catalog_name": "hive_data",
        "catalog_tags": [
          "catalog_tag_1",
          "catalog_tag_2"
        ],
        "catalog_type": "hive"
      },
      "created_by": "user1@bim.com",
      "created_on": "1686792721",
      "database_details": {
        "database_name": "new_database",
        "hostname": "netezza://ps.fyre.com",
        "password": "samplepassword",
        "port": 4353,
        "ssl": true,
        "tables": "netezza_table_name",
        "username": "sampleuser"
      },
      "database_display_name": "new_database",
      "database_id": "new_database_id",
      "database_type": "netezza",
      "description": "Description of the external Database",
      "tags": [
        "testdatabase",
        "userdatabase"
      ]
    }
  ]
}

Success example

{
  "database_registrations": [
    {
      "actions": [
        "update",
        "delete"
      ],
      "associated_catalog": {
        "catalog_name": "hive_data",
        "catalog_tags": [
          "catalog_tag_1",
          "catalog_tag_2"
        ],
        "catalog_type": "hive"
      },
      "created_by": "user1@bim.com",
      "created_on": "1686792721",
      "database_details": {
        "database_name": "new_database",
        "hostname": "netezza://ps.fyre.com",
        "password": "samplepassword",
        "port": 4353,
        "ssl": true,
        "tables": "netezza_table_name",
        "username": "sampleuser"
      },
      "database_display_name": "new_database",
      "database_id": "new_database_id",
      "database_type": "netezza",
      "description": "Description of the external Database",
      "tags": [
        "testdatabase",
        "userdatabase"
      ]
    }
  ]
}

Add or create a new database

Add or create a new database.

POST /database_registrations

(watsonxData *WatsonxDataV2) CreateDatabaseRegistration(createDatabaseRegistrationOptions *CreateDatabaseRegistrationOptions) (result *DatabaseRegistration, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) CreateDatabaseRegistrationWithContext(ctx context.Context, createDatabaseRegistrationOptions *CreateDatabaseRegistrationOptions) (result *DatabaseRegistration, response *core.DetailedResponse, err error)

ServiceCall<DatabaseRegistration> createDatabaseRegistration(CreateDatabaseRegistrationOptions createDatabaseRegistrationOptions)

create_database_registration(
        self,
        database_display_name: str,
        database_type: str,
        *,
        associated_catalog: Optional['DatabaseCatalog'] = None,
        created_on: Optional[str] = None,
        database_details: Optional['DatabaseDetails'] = None,
        database_properties: Optional[List['DatabaseRegistrationPrototypeDatabasePropertiesItems']] = None,
        description: Optional[str] = None,
        tags: Optional[List[str]] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

createDatabaseRegistration(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.database_registration.create

Request

Instantiate the CreateDatabaseRegistrationOptions struct and set the fields to provide parameter values for the CreateDatabaseRegistration method.

Use the CreateDatabaseRegistrationOptions.Builder to create a CreateDatabaseRegistrationOptions object that contains the parameter values for the createDatabaseRegistration method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Request Body

Required*

DatabaseRegistrationPrototype

Request body

parameter

WithContext method only

CreateDatabaseRegistrationOptions

The CreateDatabaseRegistration options.

CreateDatabaseRegistrationOptions

The createDatabaseRegistration options.

parameters

database_display_name
Required*
str
Database display name.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
database_type
Required*
str
Connector type.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
associated_catalog
database catalog.

Examples:
View
created_on
str
Created on.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
database_details
database details.
database_properties
This will hold all the properties for a custom database.

Possible values: 0 ≤ number of items ≤ 10000
Examples:
value
_source
_lines
_html
description
str
Database description.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
tags
List[str]
tags.

Possible values: 0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

databaseDisplayName
Required*
string
Database display name.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
databaseType
Required*
string
Connector type.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
associatedCatalog
database catalog.

Examples:
View
createdOn
string
Created on.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
databaseDetails
database details.
databaseProperties
This will hold all the properties for a custom database.

Possible values: 0 ≤ number of items ≤ 10000
Examples:
value
_source
_lines
_html
description
string
Database description.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
tags
string[]
tags.

Possible values: 0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X POST -H "accept: application/json" -H "AuthInstanceId: {instance_id}" -H "Content-Type: application/json" -d '{ "catalog_name": "sampleCatalog", "created_on": 0, "database_details": { "certificate": "contents of a pem/crt file", "certificate_extension": "pem/crt", "database_name": "new_database", "hostname": "db2@<hostname>.com", "hosts": "abc.com:1234,xyz.com:4321", "password": "samplepassword", "port": 4553, "sasl": true, "ssl": true, "tables": "kafka_table_name", "username": "sampleuser" }, "database_display_name": "new_database", "database_properties": [ { "encrypt": true, "key": "abc", "value": "xyz" } ], "database_type": "db2", "description": "db2 extenal database description", "tags": [ "tag_1", "tag_2" ] }' "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/database_registrations"

Example request

const params = {
  databaseDisplayName: 'new_database',
  databaseType: 'db2',
};

let res;
try {
  res = await watsonxDataService.createDatabaseRegistration(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

CreateDatabaseRegistrationOptions createDatabaseRegistrationOptions = new CreateDatabaseRegistrationOptions.Builder()
  .databaseDisplayName("new_database")
  .databaseType("db2")
  .build();

Response<DatabaseRegistration> response = watsonxDataService.createDatabaseRegistration(createDatabaseRegistrationOptions).execute();
DatabaseRegistration databaseRegistration = response.getResult();

System.out.println(databaseRegistration);

Example request

response = watsonx_data_service.create_database_registration(
  database_display_name='new_database',
  database_type='db2',
)
database_registration = response.get_result()

print(json.dumps(database_registration, indent=2))

Response

Response Body

DatabaseRegistration

database registration object

DatabaseRegistration

database registration object.

Examples:

View

DatabaseRegistration

database registration object.

Examples:

View

DatabaseRegistration

database registration object.

Examples:

View

DatabaseRegistration

database registration object.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "actions": [
    "update",
    "delete"
  ],
  "associated_catalog": {
    "catalog_name": "iceberg_data",
    "catalog_type": "iceberg"
  },
  "created_by": "user1@bim.com",
  "created_on": "1686792721",
  "database_details": {
    "database_name": "new_database",
    "hostname": "netezza://abc.efg.com",
    "password": "samplepassword",
    "port": 4353,
    "ssl": true,
    "tables": "netezza_table_name",
    "username": "sampleuser"
  },
  "database_display_name": "new_database",
  "database_id": "new_database_id",
  "database_type": "netezza",
  "description": "Description of the database",
  "tags": [
    "testdatabase",
    "userdatabase"
  ]
}

Success example

{
  "actions": [
    "update",
    "delete"
  ],
  "associated_catalog": {
    "catalog_name": "iceberg_data",
    "catalog_type": "iceberg"
  },
  "created_by": "user1@bim.com",
  "created_on": "1686792721",
  "database_details": {
    "database_name": "new_database",
    "hostname": "netezza://abc.efg.com",
    "password": "samplepassword",
    "port": 4353,
    "ssl": true,
    "tables": "netezza_table_name",
    "username": "sampleuser"
  },
  "database_display_name": "new_database",
  "database_id": "new_database_id",
  "database_type": "netezza",
  "description": "Description of the database",
  "tags": [
    "testdatabase",
    "userdatabase"
  ]
}

Get a registered databases

Get a registered databases.

GET /database_registrations/{database_id}

(watsonxData *WatsonxDataV2) GetDatabase(getDatabaseOptions *GetDatabaseOptions) (result *DatabaseRegistration, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) GetDatabaseWithContext(ctx context.Context, getDatabaseOptions *GetDatabaseOptions) (result *DatabaseRegistration, response *core.DetailedResponse, err error)

ServiceCall<DatabaseRegistration> getDatabase(GetDatabaseOptions getDatabaseOptions)

get_database(
        self,
        database_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

getDatabase(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.database_registration.get

Request

Instantiate the GetDatabaseOptions struct and set the fields to provide parameter values for the GetDatabase method.

Use the GetDatabaseOptions.Builder to create a GetDatabaseOptions object that contains the parameter values for the getDatabase method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

database_id
Required*
string
database id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

GetDatabaseOptions

The GetDatabase options.

GetDatabaseOptions

The getDatabase options.

parameters

database_id
Required*
str
database id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

databaseId
Required*
string
database id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X GET -H "accept: application/json" -H "AuthInstanceId: {instance_id}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/database_registrations/{database_id}"

Example request

const params = {
  databaseId: 'testString',
};

let res;
try {
  res = await watsonxDataService.getDatabase(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

GetDatabaseOptions getDatabaseOptions = new GetDatabaseOptions.Builder()
  .databaseId("testString")
  .build();

Response<DatabaseRegistration> response = watsonxDataService.getDatabase(getDatabaseOptions).execute();
DatabaseRegistration databaseRegistration = response.getResult();

System.out.println(databaseRegistration);

Example request

response = watsonx_data_service.get_database(
  database_id='testString',
)
database_registration = response.get_result()

print(json.dumps(database_registration, indent=2))

Response

Response Body

DatabaseRegistration

database registration object

DatabaseRegistration

database registration object.

Examples:

View

DatabaseRegistration

database registration object.

Examples:

View

DatabaseRegistration

database registration object.

Examples:

View

DatabaseRegistration

database registration object.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "actions": [
    "update",
    "delete"
  ],
  "associated_catalog": {
    "catalog_name": "iceberg_data",
    "catalog_type": "iceberg"
  },
  "created_by": "user1@bim.com",
  "created_on": "1686792721",
  "database_details": {
    "database_name": "new_database",
    "hostname": "netezza://abc.efg.com",
    "password": "samplepassword",
    "port": 4353,
    "ssl": true,
    "tables": "netezza_table_name",
    "username": "sampleuser"
  },
  "database_display_name": "new_database",
  "database_id": "new_database_id",
  "database_type": "netezza",
  "description": "Description of the database",
  "tags": [
    "testdatabase",
    "userdatabase"
  ]
}

Success example

{
  "actions": [
    "update",
    "delete"
  ],
  "associated_catalog": {
    "catalog_name": "iceberg_data",
    "catalog_type": "iceberg"
  },
  "created_by": "user1@bim.com",
  "created_on": "1686792721",
  "database_details": {
    "database_name": "new_database",
    "hostname": "netezza://abc.efg.com",
    "password": "samplepassword",
    "port": 4353,
    "ssl": true,
    "tables": "netezza_table_name",
    "username": "sampleuser"
  },
  "database_display_name": "new_database",
  "database_id": "new_database_id",
  "database_type": "netezza",
  "description": "Description of the database",
  "tags": [
    "testdatabase",
    "userdatabase"
  ]
}

Delete a database

Delete a database.

DELETE /database_registrations/{database_id}

(watsonxData *WatsonxDataV2) DeleteDatabaseCatalog(deleteDatabaseCatalogOptions *DeleteDatabaseCatalogOptions) (response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) DeleteDatabaseCatalogWithContext(ctx context.Context, deleteDatabaseCatalogOptions *DeleteDatabaseCatalogOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> deleteDatabaseCatalog(DeleteDatabaseCatalogOptions deleteDatabaseCatalogOptions)

delete_database_catalog(
        self,
        database_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

deleteDatabaseCatalog(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.database_registration.delete

Request

Instantiate the DeleteDatabaseCatalogOptions struct and set the fields to provide parameter values for the DeleteDatabaseCatalog method.

Use the DeleteDatabaseCatalogOptions.Builder to create a DeleteDatabaseCatalogOptions object that contains the parameter values for the deleteDatabaseCatalog method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

database_id
Required*
string
database id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

DeleteDatabaseCatalogOptions

The DeleteDatabaseCatalog options.

DeleteDatabaseCatalogOptions

The deleteDatabaseCatalog options.

parameters

database_id
Required*
str
database id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

databaseId
Required*
string
database id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X DELETE -H "accept: */*" -H "AuthInstanceId: {instance_id}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/database_registrations/{database_id}"

Example request

const params = {
  databaseId: 'testString',
};

try {
  await watsonxDataService.deleteDatabaseCatalog(params);
} catch (err) {
  console.warn(err);
}

Example request

DeleteDatabaseCatalogOptions deleteDatabaseCatalogOptions = new DeleteDatabaseCatalogOptions.Builder()
  .databaseId("testString")
  .build();

Response<Void> response = watsonxDataService.deleteDatabaseCatalog(deleteDatabaseCatalogOptions).execute();

Example request

response = watsonx_data_service.delete_database_catalog(
  database_id='testString',
)

Response

Status Code

204
No Content
400
Error
401
Unauthorized
404
Not found
500
Internal server error

No Sample Response

This method does not specify any sample responses.

Update database details

Update database details.

PATCH /database_registrations/{database_id}

(watsonxData *WatsonxDataV2) UpdateDatabase(updateDatabaseOptions *UpdateDatabaseOptions) (result *DatabaseRegistration, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) UpdateDatabaseWithContext(ctx context.Context, updateDatabaseOptions *UpdateDatabaseOptions) (result *DatabaseRegistration, response *core.DetailedResponse, err error)

ServiceCall<DatabaseRegistration> updateDatabase(UpdateDatabaseOptions updateDatabaseOptions)

update_database(
        self,
        database_id: str,
        body: List['JsonPatchOperation'],
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

updateDatabase(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.database_registration.update

Request

Instantiate the UpdateDatabaseOptions struct and set the fields to provide parameter values for the UpdateDatabase method.

Use the UpdateDatabaseOptions.Builder to create a UpdateDatabaseOptions object that contains the parameter values for the updateDatabase method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

database_id
Required*
string
database id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

Request Body

Required*

application/json-patch+jsonDatabaseRegistrationPatch

Request body

parameter

WithContext method only

UpdateDatabaseOptions

The UpdateDatabase options.

UpdateDatabaseOptions

The updateDatabase options.

parameters

database_id
Required*
str
database id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
body
Required*
List[JsonPatchOperation]
Request body.
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

databaseId
Required*
string
database id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
body
Required*
JsonPatchOperation[]
Request body.
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X PATCH -H "accept: application/json" -H "AuthInstanceId: {instance_id}" -H "Content-Type: application/json-patch+json" -d '{ "database_details": { "password": "samplepassword", "username": "sampleuser" }, "database_display_name": "new_database", "description": "External database description", "tags": [ "testdatabase", "userdatabase" ] }' "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/database_registrations/{database_id}"

Example request

// Request models needed by this operation.

// JsonPatchOperation
const jsonPatchOperationModel = {
  op: 'add',
  path: 'testString',
};

const params = {
  databaseId: 'testString',
  body: [jsonPatchOperationModel],
};

let res;
try {
  res = await watsonxDataService.updateDatabase(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

JsonPatchOperation jsonPatchOperationModel = new JsonPatchOperation.Builder()
  .op("add")
  .path("testString")
  .build();
UpdateDatabaseOptions updateDatabaseOptions = new UpdateDatabaseOptions.Builder()
  .databaseId("testString")
  .body(java.util.Arrays.asList(jsonPatchOperationModel))
  .build();

Response<DatabaseRegistration> response = watsonxDataService.updateDatabase(updateDatabaseOptions).execute();
DatabaseRegistration databaseRegistration = response.getResult();

System.out.println(databaseRegistration);

Example request

json_patch_operation_model = {
  'op': 'add',
  'path': 'testString',
}

response = watsonx_data_service.update_database(
  database_id='testString',
  body=[json_patch_operation_model],
)
database_registration = response.get_result()

print(json.dumps(database_registration, indent=2))

Response

Response Body

DatabaseRegistration

database registration object

DatabaseRegistration

database registration object.

Examples:

View

DatabaseRegistration

database registration object.

Examples:

View

DatabaseRegistration

database registration object.

Examples:

View

DatabaseRegistration

database registration object.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "actions": [
    "update",
    "delete"
  ],
  "associated_catalog": {
    "catalog_name": "iceberg_data",
    "catalog_type": "iceberg"
  },
  "created_by": "user1@bim.com",
  "created_on": "1686792721",
  "database_details": {
    "database_name": "new_database",
    "hostname": "netezza://abc.efg.com",
    "password": "samplepassword",
    "port": 4353,
    "ssl": true,
    "tables": "netezza_table_name",
    "username": "sampleuser"
  },
  "database_display_name": "new_database",
  "database_id": "new_database_id",
  "database_type": "netezza",
  "description": "Description of the database",
  "tags": [
    "testdatabase",
    "userdatabase"
  ]
}

Success example

{
  "actions": [
    "update",
    "delete"
  ],
  "associated_catalog": {
    "catalog_name": "iceberg_data",
    "catalog_type": "iceberg"
  },
  "created_by": "user1@bim.com",
  "created_on": "1686792721",
  "database_details": {
    "database_name": "new_database",
    "hostname": "netezza://abc.efg.com",
    "password": "samplepassword",
    "port": 4353,
    "ssl": true,
    "tables": "netezza_table_name",
    "username": "sampleuser"
  },
  "database_display_name": "new_database",
  "database_id": "new_database_id",
  "database_type": "netezza",
  "description": "Description of the database",
  "tags": [
    "testdatabase",
    "userdatabase"
  ]
}

API to validate the database connection

API to validate the database connection.

POST /test_database_connection

(watsonxData *WatsonxDataV2) ValidateDatabaseConnection(validateDatabaseConnectionOptions *ValidateDatabaseConnectionOptions) (result *TestDatabaseConnectionResponse, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) ValidateDatabaseConnectionWithContext(ctx context.Context, validateDatabaseConnectionOptions *ValidateDatabaseConnectionOptions) (result *TestDatabaseConnectionResponse, response *core.DetailedResponse, err error)

ServiceCall<TestDatabaseConnectionResponse> validateDatabaseConnection(ValidateDatabaseConnectionOptions validateDatabaseConnectionOptions)

validate_database_connection(
        self,
        database_details: 'ValidateDatabaseBodyDatabaseDetails',
        database_type: str,
        *,
        certificate: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

validateDatabaseConnection(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.test_database_connection.evaluate

Request

Instantiate the ValidateDatabaseConnectionOptions struct and set the fields to provide parameter values for the ValidateDatabaseConnection method.

Use the ValidateDatabaseConnectionOptions.Builder to create a ValidateDatabaseConnectionOptions object that contains the parameter values for the validateDatabaseConnection method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Request Body

Required*

ValidateDatabaseBody

Request body

parameter

WithContext method only

ValidateDatabaseConnectionOptions

The ValidateDatabaseConnection options.

ValidateDatabaseConnectionOptions

The validateDatabaseConnection options.

parameters

database_details
database details.
database_type
Required*
str
Type of db connection.

Allowable values: [mysql,postgresql,netezza,db2,mongodb,kafka,sqlserver,mycustomdb]
Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
certificate
str
contents of a pem/crt file.

Possible values: 1 ≤ length ≤ 20000, Value must match regular expression /^[a-zA-Z0-9\\-=]+/
Examples:
value
_source
_lines
_html
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

databaseDetails
database details.
databaseType
Required*
string
Type of db connection.

Allowable values: [mysql,postgresql,netezza,db2,mongodb,kafka,sqlserver,mycustomdb]
Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
certificate
string
contents of a pem/crt file.

Possible values: 1 ≤ length ≤ 20000, Value must match regular expression /^[a-zA-Z0-9\\-=]+/
Examples:
value
_source
_lines
_html
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X POST -H "accept: application/json" -H "AuthInstanceId: {instance_id}" -H "Content-Type: application/json" -d '{ "certificate": "contents of a pem/crt file", "database_details": { "database_name": "sampledatabase", "hostname": "db2@hostname.com", "password": "samplepassword", "port": 4553, "sasl": true, "ssl": true, "tables": "kafka_table_name", "username": "sampleuser" }, "database_type": "netezza", }' "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/test_database_connection"

Example request

// Request models needed by this operation.

// ValidateDatabaseBodyDatabaseDetails
const validateDatabaseBodyDatabaseDetailsModel = {
  hostname: 'db2@hostname.com',
  port: 4553,
};

const params = {
  databaseDetails: validateDatabaseBodyDatabaseDetailsModel,
  databaseType: 'netezza',
};

let res;
try {
  res = await watsonxDataService.validateDatabaseConnection(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

ValidateDatabaseBodyDatabaseDetails validateDatabaseBodyDatabaseDetailsModel = new ValidateDatabaseBodyDatabaseDetails.Builder()
  .hostname("db2@hostname.com")
  .port(Long.valueOf("4553"))
  .build();
ValidateDatabaseConnectionOptions validateDatabaseConnectionOptions = new ValidateDatabaseConnectionOptions.Builder()
  .databaseDetails(validateDatabaseBodyDatabaseDetailsModel)
  .databaseType("netezza")
  .build();

Response<TestDatabaseConnectionResponse> response = watsonxDataService.validateDatabaseConnection(validateDatabaseConnectionOptions).execute();
TestDatabaseConnectionResponse testDatabaseConnectionResponse = response.getResult();

System.out.println(testDatabaseConnectionResponse);

Example request

validate_database_body_database_details_model = {
  'hostname': 'db2@hostname.com',
  'port': 4553,
}

response = watsonx_data_service.validate_database_connection(
  database_details=validate_database_body_database_details_model,
  database_type='netezza',
)
test_database_connection_response = response.get_result()

print(json.dumps(test_database_connection_response, indent=2))

Response

Response Body

TestDatabaseConnectionResponse

Success response

TestDatabaseConnectionResponse

Success response.

Examples:

View

TestDatabaseConnectionResponse

Success response.

Examples:

View

TestDatabaseConnectionResponse

Success response.

Examples:

View

TestDatabaseConnectionResponse

Success response.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "connection_response": {
    "state": true,
    "state_message": "connection successful"
  }
}

Success example

{
  "connection_response": {
    "state": true,
    "state_message": "connection successful"
  }
}

Get list of all db2 engines

Get list of all db2 engines.

GET /db2_engines

(watsonxData *WatsonxDataV2) ListDb2Engines(listDb2EnginesOptions *ListDb2EnginesOptions) (result *Db2EngineCollection, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) ListDb2EnginesWithContext(ctx context.Context, listDb2EnginesOptions *ListDb2EnginesOptions) (result *Db2EngineCollection, response *core.DetailedResponse, err error)

ServiceCall<Db2EngineCollection> listDb2Engines(ListDb2EnginesOptions listDb2EnginesOptions)

list_db2_engines(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

listDb2Engines(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.db2_engine.list

Request

Instantiate the ListDb2EnginesOptions struct and set the fields to provide parameter values for the ListDb2Engines method.

Use the ListDb2EnginesOptions.Builder to create a ListDb2EnginesOptions object that contains the parameter values for the listDb2Engines method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

parameter

WithContext method only

ListDb2EnginesOptions

The ListDb2Engines options.

ListDb2EnginesOptions

The listDb2Engines options.

parameters

auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X GET -H "content-type: application/json" -H "AuthInstanceId: {instance_id}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/db2_engines"

Example request

let res;
try {
  res = await watsonxDataService.listDb2Engines({});
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

ListDb2EnginesOptions listDb2EnginesOptions = new ListDb2EnginesOptions.Builder()
  .build();

Response<Db2EngineCollection> response = watsonxDataService.listDb2Engines(listDb2EnginesOptions).execute();
Db2EngineCollection db2EngineCollection = response.getResult();

System.out.println(db2EngineCollection);

Example request

response = watsonx_data_service.list_db2_engines()
db2_engine_collection = response.get_result()

print(json.dumps(db2_engine_collection, indent=2))

Response

Response Body

Db2EngineCollection

list db2 engines

Db2EngineCollection

list db2 engines.

Examples:

View

Db2EngineCollection

list db2 engines.

Examples:

View

Db2EngineCollection

list db2 engines.

Examples:

View

Db2EngineCollection

list db2 engines.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "db2_engines": [
    {
      "created_by": "user@test.com",
      "created_on": 1700322436,
      "description": "db2 engine for running sql queries",
      "engine_details": {
        "connection_string": "jdbc:db2://<hostname>:<port>/<database>",
        "metastore_host": "thrift://mh-connection-string-sample.com"
      },
      "engine_display_name": "db2",
      "engine_id": "db2505",
      "origin": "external",
      "status": "REGISTERED",
      "tags": [
        "tag1",
        "tag2"
      ],
      "type": "db2"
    }
  ]
}

Success example

{
  "db2_engines": [
    {
      "created_by": "user@test.com",
      "created_on": 1700322436,
      "description": "db2 engine for running sql queries",
      "engine_details": {
        "connection_string": "jdbc:db2://<hostname>:<port>/<database>",
        "metastore_host": "thrift://mh-connection-string-sample.com"
      },
      "engine_display_name": "db2",
      "engine_id": "db2505",
      "origin": "external",
      "status": "REGISTERED",
      "tags": [
        "tag1",
        "tag2"
      ],
      "type": "db2"
    }
  ]
}

Create a new db2 engine

Create a new db2 engine.

POST /db2_engines

(watsonxData *WatsonxDataV2) CreateDb2Engine(createDb2EngineOptions *CreateDb2EngineOptions) (result *Db2Engine, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) CreateDb2EngineWithContext(ctx context.Context, createDb2EngineOptions *CreateDb2EngineOptions) (result *Db2Engine, response *core.DetailedResponse, err error)

ServiceCall<Db2Engine> createDb2Engine(CreateDb2EngineOptions createDb2EngineOptions)

create_db2_engine(
        self,
        origin: str,
        type: str,
        *,
        description: Optional[str] = None,
        engine_details: Optional['Db2EngineDetailsBody'] = None,
        engine_display_name: Optional[str] = None,
        tags: Optional[List[str]] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

createDb2Engine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.db2_engine.create

Request

Instantiate the CreateDb2EngineOptions struct and set the fields to provide parameter values for the CreateDb2Engine method.

Use the CreateDb2EngineOptions.Builder to create a CreateDb2EngineOptions object that contains the parameter values for the createDb2Engine method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Request Body

Required*

Db2EnginePrototype

Create db2 engine body

parameter

WithContext method only

CreateDb2EngineOptions

The CreateDb2Engine options.

CreateDb2EngineOptions

The createDb2Engine options.

parameters

origin
Required*
str
Origin - created or registered.

Allowable values: [native,external,discover]
Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
type
Required*
str
Engine type.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
description
str
Engine description.

Possible values: 0 ≤ length ≤ 1024, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
engine_details
External engine details.
engine_display_name
str
Engine display name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
tags
List[str]
Tags.

Possible values: 0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

origin
Required*
string
Origin - created or registered.

Allowable values: [native,external,discover]
Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
type
Required*
string
Engine type.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
description
string
Engine description.

Possible values: 0 ≤ length ≤ 1024, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
engineDetails
External engine details.
engineDisplayName
string
Engine display name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
tags
string[]
Tags.

Possible values: 0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X POST -H "accept: application/json" -H "AuthInstanceId: {instance_id}" -H "Content-Type: application/json" -d '{ "description": "db2 engine description", "engine_details": { "connection_string": "1.2.3.4" }, "engine_display_name": "sampleEngine", "origin": "external", "tags": [ "tag1", "tag2" ], "type": "db2" }' "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/db2_engines"

Example request

const params = {
  origin: 'external',
  type: 'db2',
};

let res;
try {
  res = await watsonxDataService.createDb2Engine(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

CreateDb2EngineOptions createDb2EngineOptions = new CreateDb2EngineOptions.Builder()
  .origin("external")
  .type("db2")
  .build();

Response<Db2Engine> response = watsonxDataService.createDb2Engine(createDb2EngineOptions).execute();
Db2Engine db2Engine = response.getResult();

System.out.println(db2Engine);

Example request

response = watsonx_data_service.create_db2_engine(
  origin='external',
  type='db2',
)
db2_engine = response.get_result()

print(json.dumps(db2_engine, indent=2))

Response

Response Body

Db2Engine

Db2 engine details

Db2Engine

Db2 engine details.

Examples:

View

Db2Engine

Db2 engine details.

Examples:

View

Db2Engine

Db2 engine details.

Examples:

View

Db2Engine

Db2 engine details.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "Db2Engine": null,
  "created_by": "user@test.com",
  "created_on": 1700322469,
  "description": "updated description for db2 engine.",
  "engine_details": {
    "connection_string\"": "jdbc:db2://localhost:5480/database",
    "metastore_host": "thrift://mh-connection-string-sample.com"
  },
  "engine_display_name": "sample db2 Engine Display Name",
  "engine_id": "sample db2 Engine Name",
  "origin": "external",
  "status": "REGISTERED",
  "tags": [
    "tag1",
    "tag2"
  ],
  "type": "db2"
}

Success example

{
  "Db2Engine": null,
  "created_by": "user@test.com",
  "created_on": 1700322469,
  "description": "updated description for db2 engine.",
  "engine_details": {
    "connection_string\"": "jdbc:db2://localhost:5480/database",
    "metastore_host": "thrift://mh-connection-string-sample.com"
  },
  "engine_display_name": "sample db2 Engine Display Name",
  "engine_id": "sample db2 Engine Name",
  "origin": "external",
  "status": "REGISTERED",
  "tags": [
    "tag1",
    "tag2"
  ],
  "type": "db2"
}

Delete a db2 engine

Delete a db2 engine.

DELETE /db2_engines/{engine_id}

(watsonxData *WatsonxDataV2) DeleteDb2Engine(deleteDb2EngineOptions *DeleteDb2EngineOptions) (response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) DeleteDb2EngineWithContext(ctx context.Context, deleteDb2EngineOptions *DeleteDb2EngineOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> deleteDb2Engine(DeleteDb2EngineOptions deleteDb2EngineOptions)

delete_db2_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

deleteDb2Engine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.db2_engine.delete

Request

Instantiate the DeleteDb2EngineOptions struct and set the fields to provide parameter values for the DeleteDb2Engine method.

Use the DeleteDb2EngineOptions.Builder to create a DeleteDb2EngineOptions object that contains the parameter values for the deleteDb2Engine method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

DeleteDb2EngineOptions

The DeleteDb2Engine options.

DeleteDb2EngineOptions

The deleteDb2Engine options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X DELETE -H "accept: */*" -H "AuthInstanceId: {instance_id}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/db2_engines/{engine_id}"

Example request

const params = {
  engineId: 'testString',
};

try {
  await watsonxDataService.deleteDb2Engine(params);
} catch (err) {
  console.warn(err);
}

Example request

DeleteDb2EngineOptions deleteDb2EngineOptions = new DeleteDb2EngineOptions.Builder()
  .engineId("testString")
  .build();

Response<Void> response = watsonxDataService.deleteDb2Engine(deleteDb2EngineOptions).execute();

Example request

response = watsonx_data_service.delete_db2_engine(
  engine_id='testString',
)

Response

Status Code

204
No Content
400
Error
401
Unauthorized
404
Not found
500
Internal server error

No Sample Response

This method does not specify any sample responses.

Update details of db2 engine

Update details of db2 engine.

PATCH /db2_engines/{engine_id}

(watsonxData *WatsonxDataV2) UpdateDb2Engine(updateDb2EngineOptions *UpdateDb2EngineOptions) (result *Db2Engine, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) UpdateDb2EngineWithContext(ctx context.Context, updateDb2EngineOptions *UpdateDb2EngineOptions) (result *Db2Engine, response *core.DetailedResponse, err error)

ServiceCall<Db2Engine> updateDb2Engine(UpdateDb2EngineOptions updateDb2EngineOptions)

update_db2_engine(
        self,
        engine_id: str,
        body: List['JsonPatchOperation'],
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

updateDb2Engine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.db2_engine.update

Request

Instantiate the UpdateDb2EngineOptions struct and set the fields to provide parameter values for the UpdateDb2Engine method.

Use the UpdateDb2EngineOptions.Builder to create a UpdateDb2EngineOptions object that contains the parameter values for the updateDb2Engine method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

Request Body

Required*

application/json-patch+jsonDb2EnginePatch

Update Engine Body

parameter

WithContext method only

UpdateDb2EngineOptions

The UpdateDb2Engine options.

UpdateDb2EngineOptions

The updateDb2Engine options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
body
Required*
List[JsonPatchOperation]
Update Engine Body.
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
body
Required*
JsonPatchOperation[]
Update Engine Body.
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X PATCH -H "accept: application/json" -H "AuthInstanceId: {instance_id}" -H "Content-Type: application/json-patch+json" -d '{ "description": "db2 engine updated description", "engine_display_name": "sampleEngine", "tags": [ "tag1", "tag2" ] }' "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/db2_engines/{engine_id}"

Example request

// Request models needed by this operation.

// JsonPatchOperation
const jsonPatchOperationModel = {
  op: 'add',
  path: 'testString',
};

const params = {
  engineId: 'testString',
  body: [jsonPatchOperationModel],
};

let res;
try {
  res = await watsonxDataService.updateDb2Engine(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

JsonPatchOperation jsonPatchOperationModel = new JsonPatchOperation.Builder()
  .op("add")
  .path("testString")
  .build();
UpdateDb2EngineOptions updateDb2EngineOptions = new UpdateDb2EngineOptions.Builder()
  .engineId("testString")
  .body(java.util.Arrays.asList(jsonPatchOperationModel))
  .build();

Response<Db2Engine> response = watsonxDataService.updateDb2Engine(updateDb2EngineOptions).execute();
Db2Engine db2Engine = response.getResult();

System.out.println(db2Engine);

Example request

json_patch_operation_model = {
  'op': 'add',
  'path': 'testString',
}

response = watsonx_data_service.update_db2_engine(
  engine_id='testString',
  body=[json_patch_operation_model],
)
db2_engine = response.get_result()

print(json.dumps(db2_engine, indent=2))

Response

Response Body

Db2Engine

Db2 engine details

Db2Engine

Db2 engine details.

Examples:

View

Db2Engine

Db2 engine details.

Examples:

View

Db2Engine

Db2 engine details.

Examples:

View

Db2Engine

Db2 engine details.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "Db2Engine": null,
  "created_by": "user@test.com",
  "created_on": 1700322469,
  "description": "updated description for db2 engine.",
  "engine_details": {
    "connection_string\"": "jdbc:db2://localhost:5480/database",
    "metastore_host": "thrift://mh-connection-string-sample.com"
  },
  "engine_display_name": "sample db2 Engine Display Name",
  "engine_id": "sample db2 Engine Name",
  "origin": "external",
  "status": "REGISTERED",
  "tags": [
    "tag1",
    "tag2"
  ],
  "type": "db2"
}

Success example

{
  "Db2Engine": null,
  "created_by": "user@test.com",
  "created_on": 1700322469,
  "description": "updated description for db2 engine.",
  "engine_details": {
    "connection_string\"": "jdbc:db2://localhost:5480/database",
    "metastore_host": "thrift://mh-connection-string-sample.com"
  },
  "engine_display_name": "sample db2 Engine Display Name",
  "engine_id": "sample db2 Engine Name",
  "origin": "external",
  "status": "REGISTERED",
  "tags": [
    "tag1",
    "tag2"
  ],
  "type": "db2"
}

Get all engine details

Get all engine details.

GET /engines

(watsonxData *WatsonxDataV2) GetEngines(getEnginesOptions *GetEnginesOptions) (result *Engines, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) GetEnginesWithContext(ctx context.Context, getEnginesOptions *GetEnginesOptions) (result *Engines, response *core.DetailedResponse, err error)

ServiceCall<Engines> getEngines(GetEnginesOptions getEnginesOptions)

get_engines(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

getEngines(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.engines.list

Request

Instantiate the GetEnginesOptions struct and set the fields to provide parameter values for the GetEngines method.

Use the GetEnginesOptions.Builder to create a GetEnginesOptions object that contains the parameter values for the getEngines method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

parameter

WithContext method only

GetEnginesOptions

The GetEngines options.

GetEnginesOptions

The getEngines options.

parameters

auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X GET -H "content-type: application/json" -H "AuthInstanceId: {instance id}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/engines"

Example request

let res;
try {
  res = await watsonxDataService.getEngines({});
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

GetEnginesOptions getEnginesOptions = new GetEnginesOptions.Builder()
  .build();

Response<Engines> response = watsonxDataService.getEngines(getEnginesOptions).execute();
Engines engines = response.getResult();

System.out.println(engines);

Example request

response = watsonx_data_service.get_engines()
engines = response.get_result()

print(json.dumps(engines, indent=2))

Response

Response Body

Engines

List all engines

Engines

List all engines.

Examples:

View

Engines

List all engines.

Examples:

View

Engines

List all engines.

Examples:

View

Engines

List all engines.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "engines": {
    "db2_engines": [],
    "milvus_engines": [],
    "netezza_engines": [],
    "prestissimo_engines": [],
    "presto_engines": [],
    "spark_engines": []
  }
}

Success example

{
  "engines": {
    "db2_engines": [],
    "milvus_engines": [],
    "netezza_engines": [],
    "prestissimo_engines": [],
    "presto_engines": [],
    "spark_engines": []
  }
}

Get list of all deployments

Get list of all deployments.

GET /instance

(watsonxData *WatsonxDataV2) GetDeployments(getDeploymentsOptions *GetDeploymentsOptions) (result *GetDeploymentsOKBody, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) GetDeploymentsWithContext(ctx context.Context, getDeploymentsOptions *GetDeploymentsOptions) (result *GetDeploymentsOKBody, response *core.DetailedResponse, err error)

ServiceCall<GetDeploymentsOKBody> getDeployments(GetDeploymentsOptions getDeploymentsOptions)

get_deployments(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

getDeployments(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.instance.list

Request

Instantiate the GetDeploymentsOptions struct and set the fields to provide parameter values for the GetDeployments method.

Use the GetDeploymentsOptions.Builder to create a GetDeploymentsOptions object that contains the parameter values for the getDeployments method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

parameter

WithContext method only

GetDeploymentsOptions

The GetDeployments options.

GetDeploymentsOptions

The getDeployments options.

parameters

auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'GET' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/instance' -H 'accept: application/json' -H "AuthInstanceId: {instance id}"

Example request

let res;
try {
  res = await watsonxDataService.getDeployments({});
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

GetDeploymentsOptions getDeploymentsOptions = new GetDeploymentsOptions.Builder()
  .build();

Response<GetDeploymentsOKBody> response = watsonxDataService.getDeployments(getDeploymentsOptions).execute();
GetDeploymentsOKBody getDeploymentsOkBody = response.getResult();

System.out.println(getDeploymentsOkBody);

Example request

response = watsonx_data_service.get_deployments()
get_deployments_ok_body = response.get_result()

print(json.dumps(get_deployments_ok_body, indent=2))

Response

Response Body

GetDeploymentsOKBody

Response body structure for get deployments

GetDeploymentsOKBody

Response body structure for get deployments.

Examples:

View

GetDeploymentsOKBody

Response body structure for get deployments.

Examples:

View

GetDeploymentsOKBody

Response body structure for get deployments.

Examples:

View

GetDeploymentsOKBody

Response body structure for get deployments.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "deploymentresponse": {
    "deployment": {
      "cloud_type": "aws",
      "enable_private_endpoints": true,
      "enable_public_endpoints": true,
      "first_time_use": false,
      "formation_id": "new_form_id",
      "id": "dep_id",
      "plan_id": "new_plan_id",
      "platform_options": {
        "backup_encryption_key_crn": "2nf8f8b3kd8wknfkf",
        "disk_encryption_key_crn": "hjdkd8wjnnd93ujd9",
        "key_protect_key_id": "8ndkenkwjdciendj"
      },
      "region": "us-south",
      "type": "deployment_type",
      "version": "1.0.2"
    }
  },
  "response": {
    "message": "get instance",
    "message_code": "success"
  }
}

Success example

{
  "deploymentresponse": {
    "deployment": {
      "cloud_type": "aws",
      "enable_private_endpoints": true,
      "enable_public_endpoints": true,
      "first_time_use": false,
      "formation_id": "new_form_id",
      "id": "dep_id",
      "plan_id": "new_plan_id",
      "platform_options": {
        "backup_encryption_key_crn": "2nf8f8b3kd8wknfkf",
        "disk_encryption_key_crn": "hjdkd8wjnnd93ujd9",
        "key_protect_key_id": "8ndkenkwjdciendj"
      },
      "region": "us-south",
      "type": "deployment_type",
      "version": "1.0.2"
    }
  },
  "response": {
    "message": "get instance",
    "message_code": "success"
  }
}

Get list of all netezza engines

Get list of all netezza engines.

GET /netezza_engines

(watsonxData *WatsonxDataV2) ListNetezzaEngines(listNetezzaEnginesOptions *ListNetezzaEnginesOptions) (result *NetezzaEngineCollection, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) ListNetezzaEnginesWithContext(ctx context.Context, listNetezzaEnginesOptions *ListNetezzaEnginesOptions) (result *NetezzaEngineCollection, response *core.DetailedResponse, err error)

ServiceCall<NetezzaEngineCollection> listNetezzaEngines(ListNetezzaEnginesOptions listNetezzaEnginesOptions)

list_netezza_engines(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

listNetezzaEngines(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.netezza_engine.list

Request

Instantiate the ListNetezzaEnginesOptions struct and set the fields to provide parameter values for the ListNetezzaEngines method.

Use the ListNetezzaEnginesOptions.Builder to create a ListNetezzaEnginesOptions object that contains the parameter values for the listNetezzaEngines method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

parameter

WithContext method only

ListNetezzaEnginesOptions

The ListNetezzaEngines options.

ListNetezzaEnginesOptions

The listNetezzaEngines options.

parameters

auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X GET -H "accept: application/json" -H "AuthInstanceId: {instance_id}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/netezza_engines"

Example request

let res;
try {
  res = await watsonxDataService.listNetezzaEngines({});
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

ListNetezzaEnginesOptions listNetezzaEnginesOptions = new ListNetezzaEnginesOptions.Builder()
  .build();

Response<NetezzaEngineCollection> response = watsonxDataService.listNetezzaEngines(listNetezzaEnginesOptions).execute();
NetezzaEngineCollection netezzaEngineCollection = response.getResult();

System.out.println(netezzaEngineCollection);

Example request

response = watsonx_data_service.list_netezza_engines()
netezza_engine_collection = response.get_result()

print(json.dumps(netezza_engine_collection, indent=2))

Response

Response Body

NetezzaEngineCollection

list Netezza engines

NetezzaEngineCollection

list Netezza engines.

Examples:

View

NetezzaEngineCollection

list Netezza engines.

Examples:

View

NetezzaEngineCollection

list Netezza engines.

Examples:

View

NetezzaEngineCollection

list Netezza engines.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "netezza_engines": [
    {
      "created_by": "user@test.com",
      "created_on": 1700322469,
      "description": "netezza engine for running sql queries",
      "engine_details": {
        "connection_string": "jdbc:netezza://localhost:5480/database",
        "metastore_host": "thrift://mh-connection-string-sample.com"
      },
      "engine_display_name": "netezza",
      "engine_id": "netezza170",
      "origin": "external",
      "status": "REGISTERED",
      "tags": [
        "tag1",
        "tag2"
      ],
      "type": "netezza"
    }
  ]
}

Success example

{
  "netezza_engines": [
    {
      "created_by": "user@test.com",
      "created_on": 1700322469,
      "description": "netezza engine for running sql queries",
      "engine_details": {
        "connection_string": "jdbc:netezza://localhost:5480/database",
        "metastore_host": "thrift://mh-connection-string-sample.com"
      },
      "engine_display_name": "netezza",
      "engine_id": "netezza170",
      "origin": "external",
      "status": "REGISTERED",
      "tags": [
        "tag1",
        "tag2"
      ],
      "type": "netezza"
    }
  ]
}

Create a new netezza engine

Create a new netezza engine.

POST /netezza_engines

(watsonxData *WatsonxDataV2) CreateNetezzaEngine(createNetezzaEngineOptions *CreateNetezzaEngineOptions) (result *NetezzaEngine, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) CreateNetezzaEngineWithContext(ctx context.Context, createNetezzaEngineOptions *CreateNetezzaEngineOptions) (result *NetezzaEngine, response *core.DetailedResponse, err error)

ServiceCall<NetezzaEngine> createNetezzaEngine(CreateNetezzaEngineOptions createNetezzaEngineOptions)

create_netezza_engine(
        self,
        origin: str,
        type: str,
        *,
        description: Optional[str] = None,
        engine_details: Optional['NetezzaEngineDetailsBody'] = None,
        engine_display_name: Optional[str] = None,
        tags: Optional[List[str]] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

createNetezzaEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.netezza_engine.create

Request

Instantiate the CreateNetezzaEngineOptions struct and set the fields to provide parameter values for the CreateNetezzaEngine method.

Use the CreateNetezzaEngineOptions.Builder to create a CreateNetezzaEngineOptions object that contains the parameter values for the createNetezzaEngine method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Request Body

Required*

NetezzaEnginePrototype

Create netezza engine body

parameter

WithContext method only

CreateNetezzaEngineOptions

The CreateNetezzaEngine options.

CreateNetezzaEngineOptions

The createNetezzaEngine options.

parameters

origin
Required*
str
Origin - created or registered.

Allowable values: [native,external,discover]
Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
type
Required*
str
Engine type.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
description
str
Engine description.

Possible values: 0 ≤ length ≤ 1024, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
engine_details
External engine details.
engine_display_name
str
Engine display name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
tags
List[str]
Tags.

Possible values: 0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

origin
Required*
string
Origin - created or registered.

Allowable values: [native,external,discover]
Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
type
Required*
string
Engine type.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
description
string
Engine description.

Possible values: 0 ≤ length ≤ 1024, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
engineDetails
External engine details.
engineDisplayName
string
Engine display name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
tags
string[]
Tags.

Possible values: 0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X POST -H "accept: application/json" -H "AuthInstanceId: {instance_id}" -H "Content-Type: application/json" -d '{ "description": "netezza engine description", "engine_details": { "connection_string": "1.2.3.4" }, "engine_display_name": "sampleEngine", "origin": "external", "tags": [ "tag1", "tag2" ], "type": "netezza" }' "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/netezza_engines"

Example request

const params = {
  origin: 'external',
  type: 'netezza',
};

let res;
try {
  res = await watsonxDataService.createNetezzaEngine(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

CreateNetezzaEngineOptions createNetezzaEngineOptions = new CreateNetezzaEngineOptions.Builder()
  .origin("external")
  .type("netezza")
  .build();

Response<NetezzaEngine> response = watsonxDataService.createNetezzaEngine(createNetezzaEngineOptions).execute();
NetezzaEngine netezzaEngine = response.getResult();

System.out.println(netezzaEngine);

Example request

response = watsonx_data_service.create_netezza_engine(
  origin='external',
  type='netezza',
)
netezza_engine = response.get_result()

print(json.dumps(netezza_engine, indent=2))

Response

Response Body

NetezzaEngine

Netezza engine details

NetezzaEngine

Netezza engine details.

Examples:

View

NetezzaEngine

Netezza engine details.

Examples:

View

NetezzaEngine

Netezza engine details.

Examples:

View

NetezzaEngine

Netezza engine details.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "NetezzaEngine": null,
  "created_by": "user@test.com",
  "created_on": 1700322469,
  "description": "updated description for netezza engine.",
  "engine_details": {
    "connection_string\"": "jdbc:netezza://localhost:5480/database",
    "metastore_host": "thrift://mh-connection-string-sample.com"
  },
  "engine_display_name": "sample Netezza Engine Display Name",
  "engine_id": "sample Netezza Engine Name",
  "origin": "external",
  "status": "REGISTERED",
  "tags": [
    "tag1",
    "tag2"
  ],
  "type": "netezza"
}

Success example

{
  "NetezzaEngine": null,
  "created_by": "user@test.com",
  "created_on": 1700322469,
  "description": "updated description for netezza engine.",
  "engine_details": {
    "connection_string\"": "jdbc:netezza://localhost:5480/database",
    "metastore_host": "thrift://mh-connection-string-sample.com"
  },
  "engine_display_name": "sample Netezza Engine Display Name",
  "engine_id": "sample Netezza Engine Name",
  "origin": "external",
  "status": "REGISTERED",
  "tags": [
    "tag1",
    "tag2"
  ],
  "type": "netezza"
}

Delete a netezza engine

Delete a netezza engine.

DELETE /netezza_engines/{engine_id}

(watsonxData *WatsonxDataV2) DeleteNetezzaEngine(deleteNetezzaEngineOptions *DeleteNetezzaEngineOptions) (response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) DeleteNetezzaEngineWithContext(ctx context.Context, deleteNetezzaEngineOptions *DeleteNetezzaEngineOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> deleteNetezzaEngine(DeleteNetezzaEngineOptions deleteNetezzaEngineOptions)

delete_netezza_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

deleteNetezzaEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.netezza_engine.delete

Request

Instantiate the DeleteNetezzaEngineOptions struct and set the fields to provide parameter values for the DeleteNetezzaEngine method.

Use the DeleteNetezzaEngineOptions.Builder to create a DeleteNetezzaEngineOptions object that contains the parameter values for the deleteNetezzaEngine method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

DeleteNetezzaEngineOptions

The DeleteNetezzaEngine options.

DeleteNetezzaEngineOptions

The deleteNetezzaEngine options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X DELETE -H "accept: */* " -H "AuthInstanceId: {instance_id}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/netezza_engines/{engine_id}"

Example request

const params = {
  engineId: 'testString',
};

try {
  await watsonxDataService.deleteNetezzaEngine(params);
} catch (err) {
  console.warn(err);
}

Example request

DeleteNetezzaEngineOptions deleteNetezzaEngineOptions = new DeleteNetezzaEngineOptions.Builder()
  .engineId("testString")
  .build();

Response<Void> response = watsonxDataService.deleteNetezzaEngine(deleteNetezzaEngineOptions).execute();

Example request

response = watsonx_data_service.delete_netezza_engine(
  engine_id='testString',
)

Response

Status Code

204
No Content
400
Error
401
Unauthorized
404
Not found
500
Internal server error

No Sample Response

This method does not specify any sample responses.

Update details of netezza engine

Update details of netezza engine.

PATCH /netezza_engines/{engine_id}

(watsonxData *WatsonxDataV2) UpdateNetezzaEngine(updateNetezzaEngineOptions *UpdateNetezzaEngineOptions) (result *NetezzaEngine, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) UpdateNetezzaEngineWithContext(ctx context.Context, updateNetezzaEngineOptions *UpdateNetezzaEngineOptions) (result *NetezzaEngine, response *core.DetailedResponse, err error)

ServiceCall<NetezzaEngine> updateNetezzaEngine(UpdateNetezzaEngineOptions updateNetezzaEngineOptions)

update_netezza_engine(
        self,
        engine_id: str,
        body: List['JsonPatchOperation'],
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

updateNetezzaEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.netezza_engine.update

Request

Instantiate the UpdateNetezzaEngineOptions struct and set the fields to provide parameter values for the UpdateNetezzaEngine method.

Use the UpdateNetezzaEngineOptions.Builder to create a UpdateNetezzaEngineOptions object that contains the parameter values for the updateNetezzaEngine method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

Request Body

Required*

application/json-patch+jsonNetezzaEnginePatch

Update Engine Body

parameter

WithContext method only

UpdateNetezzaEngineOptions

The UpdateNetezzaEngine options.

UpdateNetezzaEngineOptions

The updateNetezzaEngine options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
body
Required*
List[JsonPatchOperation]
Update Engine Body.
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
body
Required*
JsonPatchOperation[]
Update Engine Body.
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X PATCH -H "accept: application/json" -H "AuthInstanceId: {instance_id}" -H "Content-Type: application/json-patch+json" -d '{ "description": "netezza engine updated description", "engine_display_name": "sampleEngine", "tags": [ "tag1", "tag2" ] }' "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/netezza_engines/{engine_id}"

Example request

// Request models needed by this operation.

// JsonPatchOperation
const jsonPatchOperationModel = {
  op: 'add',
  path: 'testString',
};

const params = {
  engineId: 'testString',
  body: [jsonPatchOperationModel],
};

let res;
try {
  res = await watsonxDataService.updateNetezzaEngine(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

JsonPatchOperation jsonPatchOperationModel = new JsonPatchOperation.Builder()
  .op("add")
  .path("testString")
  .build();
UpdateNetezzaEngineOptions updateNetezzaEngineOptions = new UpdateNetezzaEngineOptions.Builder()
  .engineId("testString")
  .body(java.util.Arrays.asList(jsonPatchOperationModel))
  .build();

Response<NetezzaEngine> response = watsonxDataService.updateNetezzaEngine(updateNetezzaEngineOptions).execute();
NetezzaEngine netezzaEngine = response.getResult();

System.out.println(netezzaEngine);

Example request

json_patch_operation_model = {
  'op': 'add',
  'path': 'testString',
}

response = watsonx_data_service.update_netezza_engine(
  engine_id='testString',
  body=[json_patch_operation_model],
)
netezza_engine = response.get_result()

print(json.dumps(netezza_engine, indent=2))

Response

Response Body

NetezzaEngine

Netezza engine details

NetezzaEngine

Netezza engine details.

Examples:

View

NetezzaEngine

Netezza engine details.

Examples:

View

NetezzaEngine

Netezza engine details.

Examples:

View

NetezzaEngine

Netezza engine details.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "NetezzaEngine": null,
  "created_by": "user@test.com",
  "created_on": 1700322469,
  "description": "updated description for netezza engine.",
  "engine_details": {
    "connection_string\"": "jdbc:netezza://localhost:5480/database",
    "metastore_host": "thrift://mh-connection-string-sample.com"
  },
  "engine_display_name": "sample Netezza Engine Display Name",
  "engine_id": "sample Netezza Engine Name",
  "origin": "external",
  "status": "REGISTERED",
  "tags": [
    "tag1",
    "tag2"
  ],
  "type": "netezza"
}

Success example

{
  "NetezzaEngine": null,
  "created_by": "user@test.com",
  "created_on": 1700322469,
  "description": "updated description for netezza engine.",
  "engine_details": {
    "connection_string\"": "jdbc:netezza://localhost:5480/database",
    "metastore_host": "thrift://mh-connection-string-sample.com"
  },
  "engine_display_name": "sample Netezza Engine Display Name",
  "engine_id": "sample Netezza Engine Name",
  "origin": "external",
  "status": "REGISTERED",
  "tags": [
    "tag1",
    "tag2"
  ],
  "type": "netezza"
}

list all other engine details

list all other engine details.

GET /other_engines

(watsonxData *WatsonxDataV2) ListOtherEngines(listOtherEnginesOptions *ListOtherEnginesOptions) (result *OtherEngineCollection, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) ListOtherEnginesWithContext(ctx context.Context, listOtherEnginesOptions *ListOtherEnginesOptions) (result *OtherEngineCollection, response *core.DetailedResponse, err error)

ServiceCall<OtherEngineCollection> listOtherEngines(ListOtherEnginesOptions listOtherEnginesOptions)

list_other_engines(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

listOtherEngines(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.other_engine.list

Request

Instantiate the ListOtherEnginesOptions struct and set the fields to provide parameter values for the ListOtherEngines method.

Use the ListOtherEnginesOptions.Builder to create a ListOtherEnginesOptions object that contains the parameter values for the listOtherEngines method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

parameter

WithContext method only

ListOtherEnginesOptions

The ListOtherEngines options.

ListOtherEnginesOptions

The listOtherEngines options.

parameters

auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X GET -H "content-type: application/json" -H "AuthInstanceId: {instance_id}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/other_engines"

Example request

let res;
try {
  res = await watsonxDataService.listOtherEngines({});
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

ListOtherEnginesOptions listOtherEnginesOptions = new ListOtherEnginesOptions.Builder()
  .build();

Response<OtherEngineCollection> response = watsonxDataService.listOtherEngines(listOtherEnginesOptions).execute();
OtherEngineCollection otherEngineCollection = response.getResult();

System.out.println(otherEngineCollection);

Example request

response = watsonx_data_service.list_other_engines()
other_engine_collection = response.get_result()

print(json.dumps(other_engine_collection, indent=2))

Response

Response Body

OtherEngineCollection

list other engines

OtherEngineCollection

list other engines.

Examples:

View

OtherEngineCollection

list other engines.

Examples:

View

OtherEngineCollection

list other engines.

Examples:

View

OtherEngineCollection

list other engines.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "other_engines": [
    {
      "created_by": "<username>@<domain>.com",
      "created_on": 163788384993,
      "description": "other engine for running queries",
      "engine_details": {
        "connection_string": "https://other-connection-string-sample.com",
        "engine_type": "netezza"
      },
      "engine_display_name": "sampleEngine",
      "engine_id": "sampleEngine123",
      "origin": "external",
      "status": "registered",
      "type": "other"
    }
  ]
}

Success example

{
  "other_engines": [
    {
      "created_by": "<username>@<domain>.com",
      "created_on": 163788384993,
      "description": "other engine for running queries",
      "engine_details": {
        "connection_string": "https://other-connection-string-sample.com",
        "engine_type": "netezza"
      },
      "engine_display_name": "sampleEngine",
      "engine_id": "sampleEngine123",
      "origin": "external",
      "status": "registered",
      "type": "other"
    }
  ]
}

Create a new engine

Create a new engine.

POST /other_engines

(watsonxData *WatsonxDataV2) CreateOtherEngine(createOtherEngineOptions *CreateOtherEngineOptions) (result *OtherEngine, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) CreateOtherEngineWithContext(ctx context.Context, createOtherEngineOptions *CreateOtherEngineOptions) (result *OtherEngine, response *core.DetailedResponse, err error)

ServiceCall<OtherEngine> createOtherEngine(CreateOtherEngineOptions createOtherEngineOptions)

create_other_engine(
        self,
        engine_details: 'OtherEngineDetailsBody',
        engine_display_name: str,
        *,
        description: Optional[str] = None,
        origin: Optional[str] = None,
        tags: Optional[List[str]] = None,
        type: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

createOtherEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.other_engine.create

Request

Instantiate the CreateOtherEngineOptions struct and set the fields to provide parameter values for the CreateOtherEngine method.

Use the CreateOtherEngineOptions.Builder to create a CreateOtherEngineOptions object that contains the parameter values for the createOtherEngine method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Request Body

Required*

OtherEnginePrototype

Create other Engine Body

parameter

WithContext method only

CreateOtherEngineOptions

The CreateOtherEngine options.

CreateOtherEngineOptions

The createOtherEngine options.

parameters

engine_details
External engine details.
engine_display_name
Required*
str
engine display name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
description
str
engine description.

Possible values: 1 ≤ length ≤ 1000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
origin
str
Origin - created or registered.

Allowable values: [native,external,discover]
Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
tags
List[str]
other engine tags.

Possible values: 0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
type
str
Engine type.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineDetails
External engine details.
engineDisplayName
Required*
string
engine display name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
description
string
engine description.

Possible values: 1 ≤ length ≤ 1000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
origin
string
Origin - created or registered.

Allowable values: [native,external,discover]
Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
tags
string[]
other engine tags.

Possible values: 0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
type
string
Engine type.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X POST -H "content-type: application/json" -H "accept: application/json" -H "AuthInstanceId: {instance_id}" -d '{ "description": "external engine description", "engine_details": { "connection_string": "1.2.3.4", "engine_type": "netezza", "metastore_host": "1.2.3.4" }, "engine_display_name": "sampleEngine01", "tags": [ "tag1", "tag2" ] }' "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/other_engines"

Example request

// Request models needed by this operation.

// OtherEngineDetailsBody
const otherEngineDetailsBodyModel = {
  connection_string: '1.2.3.4',
  engine_type: 'netezza',
};

const params = {
  engineDetails: otherEngineDetailsBodyModel,
  engineDisplayName: 'sampleEngine01',
};

let res;
try {
  res = await watsonxDataService.createOtherEngine(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

OtherEngineDetailsBody otherEngineDetailsBodyModel = new OtherEngineDetailsBody.Builder()
  .connectionString("1.2.3.4")
  .engineType("netezza")
  .build();
CreateOtherEngineOptions createOtherEngineOptions = new CreateOtherEngineOptions.Builder()
  .engineDetails(otherEngineDetailsBodyModel)
  .engineDisplayName("sampleEngine01")
  .build();

Response<OtherEngine> response = watsonxDataService.createOtherEngine(createOtherEngineOptions).execute();
OtherEngine otherEngine = response.getResult();

System.out.println(otherEngine);

Example request

other_engine_details_body_model = {
  'connection_string': '1.2.3.4',
  'engine_type': 'netezza',
}

response = watsonx_data_service.create_other_engine(
  engine_details=other_engine_details_body_model,
  engine_display_name='sampleEngine01',
)
other_engine = response.get_result()

print(json.dumps(other_engine, indent=2))

Response

Response Body

OtherEngine

external engine details

OtherEngine

external engine details.

Examples:

View

OtherEngine

external engine details.

Examples:

View

OtherEngine

external engine details.

Examples:

View

OtherEngine

external engine details.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "OtherEngine": {
    "created_by": "<username>@<domain>.com",
    "created_on": 163788384993,
    "description": "other engine for running sql queries",
    "engine_display_name": "sampleEngine",
    "engine_id": "sampleEngine123",
    "origin": "external",
    "status": "registered",
    "type": "other"
  }
}

Success example

{
  "OtherEngine": {
    "created_by": "<username>@<domain>.com",
    "created_on": 163788384993,
    "description": "other engine for running sql queries",
    "engine_display_name": "sampleEngine",
    "engine_id": "sampleEngine123",
    "origin": "external",
    "status": "registered",
    "type": "other"
  }
}

Delete an engine from lakehouse

Delete an engine from lakehouse.

DELETE /other_engines/{engine_id}

(watsonxData *WatsonxDataV2) DeleteOtherEngine(deleteOtherEngineOptions *DeleteOtherEngineOptions) (response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) DeleteOtherEngineWithContext(ctx context.Context, deleteOtherEngineOptions *DeleteOtherEngineOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> deleteOtherEngine(DeleteOtherEngineOptions deleteOtherEngineOptions)

delete_other_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

deleteOtherEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.other_engine.delete

Request

Instantiate the DeleteOtherEngineOptions struct and set the fields to provide parameter values for the DeleteOtherEngine method.

Use the DeleteOtherEngineOptions.Builder to create a DeleteOtherEngineOptions object that contains the parameter values for the deleteOtherEngine method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

DeleteOtherEngineOptions

The DeleteOtherEngine options.

DeleteOtherEngineOptions

The deleteOtherEngine options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X DELETE -H "accept: */*" -H "AuthInstanceId: {instance_id}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/other_engines/{engine_id}"

Example request

const params = {
  engineId: 'testString',
};

try {
  await watsonxDataService.deleteOtherEngine(params);
} catch (err) {
  console.warn(err);
}

Example request

DeleteOtherEngineOptions deleteOtherEngineOptions = new DeleteOtherEngineOptions.Builder()
  .engineId("testString")
  .build();

Response<Void> response = watsonxDataService.deleteOtherEngine(deleteOtherEngineOptions).execute();

Example request

response = watsonx_data_service.delete_other_engine(
  engine_id='testString',
)

Response

Status Code

204
No Content
400
Error
401
Unauthorized
404
Not found
500
Internal server error

No Sample Response

This method does not specify any sample responses.

Get list of all prestissimo engines

Get list of all prestissimo engines.

GET /prestissimo_engines

(watsonxData *WatsonxDataV2) ListPrestissimoEngines(listPrestissimoEnginesOptions *ListPrestissimoEnginesOptions) (result *PrestissimoEngineCollection, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) ListPrestissimoEnginesWithContext(ctx context.Context, listPrestissimoEnginesOptions *ListPrestissimoEnginesOptions) (result *PrestissimoEngineCollection, response *core.DetailedResponse, err error)

ServiceCall<PrestissimoEngineCollection> listPrestissimoEngines(ListPrestissimoEnginesOptions listPrestissimoEnginesOptions)

list_prestissimo_engines(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

listPrestissimoEngines(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.prestissimo_engine.list

Request

Instantiate the ListPrestissimoEnginesOptions struct and set the fields to provide parameter values for the ListPrestissimoEngines method.

Use the ListPrestissimoEnginesOptions.Builder to create a ListPrestissimoEnginesOptions object that contains the parameter values for the listPrestissimoEngines method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

parameter

WithContext method only

ListPrestissimoEnginesOptions

The ListPrestissimoEngines options.

ListPrestissimoEnginesOptions

The listPrestissimoEngines options.

parameters

auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

Example request

let res;
try {
  res = await watsonxDataService.listPrestissimoEngines({});
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

ListPrestissimoEnginesOptions listPrestissimoEnginesOptions = new ListPrestissimoEnginesOptions.Builder()
  .build();

Response<PrestissimoEngineCollection> response = watsonxDataService.listPrestissimoEngines(listPrestissimoEnginesOptions).execute();
PrestissimoEngineCollection prestissimoEngineCollection = response.getResult();

System.out.println(prestissimoEngineCollection);

Example request

response = watsonx_data_service.list_prestissimo_engines()
prestissimo_engine_collection = response.get_result()

print(json.dumps(prestissimo_engine_collection, indent=2))

Response

Response Body

PrestissimoEngineCollection

list Prestissimo Engines

PrestissimoEngineCollection

list Prestissimo Engines.

Examples:

View

PrestissimoEngineCollection

list Prestissimo Engines.

Examples:

View

PrestissimoEngineCollection

list Prestissimo Engines.

Examples:

View

PrestissimoEngineCollection

list Prestissimo Engines.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "prestissimo_engines": [
    {
      "actions": [
        "view",
        "use",
        "update",
        "select",
        "access_ui",
        "associate",
        "disassociate",
        "restart",
        "pause",
        "resume",
        "grant",
        "revoke",
        "delete",
        "create",
        "scale"
      ],
      "associated_catalogs": [
        "hive_data"
      ],
      "build_version": "1.1.0.0.0",
      "coordinator": {
        "node_type": "bx2.4x16",
        "quantity": 1
      },
      "engine_display_name": "starter",
      "engine_id": "prestissimo511",
      "external_host_name": "your-hostname.apps.your-domain.com",
      "group_id": "prestissimo511",
      "host_name": "1234-xyz456-abc4321.databases.appdomain.cloud",
      "port": 30156,
      "size_config": "starter",
      "status": "running",
      "status_code": 0,
      "tags": [
        "tag1",
        "tag2"
      ],
      "type": "prestissimo",
      "version": "v0.282",
      "worker": {
        "node_type": "bx2.4x16",
        "quantity": 1
      }
    }
  ]
}

Success example

{
  "prestissimo_engines": [
    {
      "actions": [
        "view",
        "use",
        "update",
        "select",
        "access_ui",
        "associate",
        "disassociate",
        "restart",
        "pause",
        "resume",
        "grant",
        "revoke",
        "delete",
        "create",
        "scale"
      ],
      "associated_catalogs": [
        "hive_data"
      ],
      "build_version": "1.1.0.0.0",
      "coordinator": {
        "node_type": "bx2.4x16",
        "quantity": 1
      },
      "engine_display_name": "starter",
      "engine_id": "prestissimo511",
      "external_host_name": "your-hostname.apps.your-domain.com",
      "group_id": "prestissimo511",
      "host_name": "1234-xyz456-abc4321.databases.appdomain.cloud",
      "port": 30156,
      "size_config": "starter",
      "status": "running",
      "status_code": 0,
      "tags": [
        "tag1",
        "tag2"
      ],
      "type": "prestissimo",
      "version": "v0.282",
      "worker": {
        "node_type": "bx2.4x16",
        "quantity": 1
      }
    }
  ]
}

Create a new prestissimo engine

Create a new prestissimo engine.

POST /prestissimo_engines

(watsonxData *WatsonxDataV2) CreatePrestissimoEngine(createPrestissimoEngineOptions *CreatePrestissimoEngineOptions) (result *PrestissimoEngine, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) CreatePrestissimoEngineWithContext(ctx context.Context, createPrestissimoEngineOptions *CreatePrestissimoEngineOptions) (result *PrestissimoEngine, response *core.DetailedResponse, err error)

ServiceCall<PrestissimoEngine> createPrestissimoEngine(CreatePrestissimoEngineOptions createPrestissimoEngineOptions)

create_prestissimo_engine(
        self,
        origin: str,
        type: str,
        *,
        associated_catalogs: Optional[List[str]] = None,
        description: Optional[str] = None,
        engine_details: Optional['PrestissimoEngineDetails'] = None,
        engine_display_name: Optional[str] = None,
        region: Optional[str] = None,
        tags: Optional[List[str]] = None,
        version: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

createPrestissimoEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.prestissimo_engine.create

Request

Instantiate the CreatePrestissimoEngineOptions struct and set the fields to provide parameter values for the CreatePrestissimoEngine method.

Use the CreatePrestissimoEngineOptions.Builder to create a CreatePrestissimoEngineOptions object that contains the parameter values for the createPrestissimoEngine method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Request Body

Required*

PrestissimoEnginePrototype

Create Engine Body

parameter

WithContext method only

CreatePrestissimoEngineOptions

The CreatePrestissimoEngine options.

CreatePrestissimoEngineOptions

The createPrestissimoEngine options.

parameters

origin
Required*
str
Origin - created or registered.

Allowable values: [native,external,discover]
Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
type
Required*
str
Engine type prestissimo, others like netezza.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
associated_catalogs
List[str]
Associated catalogs.

Possible values: 0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
description
str
Engine description.

Possible values: 0 ≤ length ≤ 1000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
engine_details
External engine details.
engine_display_name
str
Engine display name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
region
str
Region (cloud).

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
tags
List[str]
Tags.

Possible values: 0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
version
str
Version like 0.278 for prestissimo or else.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

origin
Required*
string
Origin - created or registered.

Allowable values: [native,external,discover]
Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
type
Required*
string
Engine type prestissimo, others like netezza.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
associatedCatalogs
string[]
Associated catalogs.

Possible values: 0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
description
string
Engine description.

Possible values: 0 ≤ length ≤ 1000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
engineDetails
External engine details.
engineDisplayName
string
Engine display name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
region
string
Region (cloud).

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
tags
string[]
Tags.

Possible values: 0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
version
string
Version like 0.278 for prestissimo or else.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

Example request

const params = {
  origin: 'native',
  type: 'prestissimo',
};

let res;
try {
  res = await watsonxDataService.createPrestissimoEngine(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

CreatePrestissimoEngineOptions createPrestissimoEngineOptions = new CreatePrestissimoEngineOptions.Builder()
  .origin("native")
  .type("prestissimo")
  .build();

Response<PrestissimoEngine> response = watsonxDataService.createPrestissimoEngine(createPrestissimoEngineOptions).execute();
PrestissimoEngine prestissimoEngine = response.getResult();

System.out.println(prestissimoEngine);

Example request

response = watsonx_data_service.create_prestissimo_engine(
  origin='native',
  type='prestissimo',
)
prestissimo_engine = response.get_result()

print(json.dumps(prestissimo_engine, indent=2))

Response

Response Body

PrestissimoEngine

EngineDetail

PrestissimoEngine

EngineDetail.

Examples:

View

PrestissimoEngine

EngineDetail.

Examples:

View

PrestissimoEngine

EngineDetail.

Examples:

View

PrestissimoEngine

EngineDetail.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "actions": [
    "update",
    "delete"
  ],
  "associated_catalogs": [
    "hive_data"
  ],
  "coordinator": {
    "node_type": "worker",
    "quantity": 1
  },
  "created_by": "<username>@<domain>.com",
  "created_on": 163788384993,
  "description": "prestissimo engine for running sql queries",
  "engine_display_name": "sampleEngine",
  "engine_id": "sampleEngine123",
  "external_host_name": "your-hostname.apps.your-domain.com",
  "group_id": "new_group_id",
  "host_name": "your-hostname.apps.your-domain.com",
  "origin": "native",
  "region": "us-south",
  "size_config": "starter",
  "status": "running",
  "status_code": 0,
  "tags": [
    "tag1",
    "tag2"
  ],
  "version": "1.2.0",
  "worker": {
    "node_type": "worker",
    "quantity": 1
  }
}

Success example

{
  "actions": [
    "update",
    "delete"
  ],
  "associated_catalogs": [
    "hive_data"
  ],
  "coordinator": {
    "node_type": "worker",
    "quantity": 1
  },
  "created_by": "<username>@<domain>.com",
  "created_on": 163788384993,
  "description": "prestissimo engine for running sql queries",
  "engine_display_name": "sampleEngine",
  "engine_id": "sampleEngine123",
  "external_host_name": "your-hostname.apps.your-domain.com",
  "group_id": "new_group_id",
  "host_name": "your-hostname.apps.your-domain.com",
  "origin": "native",
  "region": "us-south",
  "size_config": "starter",
  "status": "running",
  "status_code": 0,
  "tags": [
    "tag1",
    "tag2"
  ],
  "version": "1.2.0",
  "worker": {
    "node_type": "worker",
    "quantity": 1
  }
}

Get details of one prestissimo engine

Get details of one prestissimo engine.

GET /prestissimo_engines/{engine_id}

(watsonxData *WatsonxDataV2) GetPrestissimoEngine(getPrestissimoEngineOptions *GetPrestissimoEngineOptions) (result *PrestissimoEngine, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) GetPrestissimoEngineWithContext(ctx context.Context, getPrestissimoEngineOptions *GetPrestissimoEngineOptions) (result *PrestissimoEngine, response *core.DetailedResponse, err error)

ServiceCall<PrestissimoEngine> getPrestissimoEngine(GetPrestissimoEngineOptions getPrestissimoEngineOptions)

get_prestissimo_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

getPrestissimoEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.prestissimo_engine.get

Request

Instantiate the GetPrestissimoEngineOptions struct and set the fields to provide parameter values for the GetPrestissimoEngine method.

Use the GetPrestissimoEngineOptions.Builder to create a GetPrestissimoEngineOptions object that contains the parameter values for the getPrestissimoEngine method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

GetPrestissimoEngineOptions

The GetPrestissimoEngine options.

GetPrestissimoEngineOptions

The getPrestissimoEngine options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

Example request

const params = {
  engineId: 'testString',
};

let res;
try {
  res = await watsonxDataService.getPrestissimoEngine(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

GetPrestissimoEngineOptions getPrestissimoEngineOptions = new GetPrestissimoEngineOptions.Builder()
  .engineId("testString")
  .build();

Response<PrestissimoEngine> response = watsonxDataService.getPrestissimoEngine(getPrestissimoEngineOptions).execute();
PrestissimoEngine prestissimoEngine = response.getResult();

System.out.println(prestissimoEngine);

Example request

response = watsonx_data_service.get_prestissimo_engine(
  engine_id='testString',
)
prestissimo_engine = response.get_result()

print(json.dumps(prestissimo_engine, indent=2))

Response

Response Body

PrestissimoEngine

EngineDetail

PrestissimoEngine

EngineDetail.

Examples:

View

PrestissimoEngine

EngineDetail.

Examples:

View

PrestissimoEngine

EngineDetail.

Examples:

View

PrestissimoEngine

EngineDetail.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "actions": [
    "update",
    "delete"
  ],
  "associated_catalogs": [
    "hive_data"
  ],
  "coordinator": {
    "node_type": "worker",
    "quantity": 1
  },
  "created_by": "<username>@<domain>.com",
  "created_on": 163788384993,
  "description": "prestissimo engine for running sql queries",
  "engine_display_name": "sampleEngine",
  "engine_id": "sampleEngine123",
  "external_host_name": "your-hostname.apps.your-domain.com",
  "group_id": "new_group_id",
  "host_name": "your-hostname.apps.your-domain.com",
  "origin": "native",
  "region": "us-south",
  "size_config": "starter",
  "status": "running",
  "status_code": 0,
  "tags": [
    "tag1",
    "tag2"
  ],
  "version": "1.2.0",
  "worker": {
    "node_type": "worker",
    "quantity": 1
  }
}

Success example

{
  "actions": [
    "update",
    "delete"
  ],
  "associated_catalogs": [
    "hive_data"
  ],
  "coordinator": {
    "node_type": "worker",
    "quantity": 1
  },
  "created_by": "<username>@<domain>.com",
  "created_on": 163788384993,
  "description": "prestissimo engine for running sql queries",
  "engine_display_name": "sampleEngine",
  "engine_id": "sampleEngine123",
  "external_host_name": "your-hostname.apps.your-domain.com",
  "group_id": "new_group_id",
  "host_name": "your-hostname.apps.your-domain.com",
  "origin": "native",
  "region": "us-south",
  "size_config": "starter",
  "status": "running",
  "status_code": 0,
  "tags": [
    "tag1",
    "tag2"
  ],
  "version": "1.2.0",
  "worker": {
    "node_type": "worker",
    "quantity": 1
  }
}

Delete a prestissimo engine

Delete a prestissimo engine.

DELETE /prestissimo_engines/{engine_id}

(watsonxData *WatsonxDataV2) DeletePrestissimoEngine(deletePrestissimoEngineOptions *DeletePrestissimoEngineOptions) (response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) DeletePrestissimoEngineWithContext(ctx context.Context, deletePrestissimoEngineOptions *DeletePrestissimoEngineOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> deletePrestissimoEngine(DeletePrestissimoEngineOptions deletePrestissimoEngineOptions)

delete_prestissimo_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

deletePrestissimoEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.prestissimo_engine.delete

Request

Instantiate the DeletePrestissimoEngineOptions struct and set the fields to provide parameter values for the DeletePrestissimoEngine method.

Use the DeletePrestissimoEngineOptions.Builder to create a DeletePrestissimoEngineOptions object that contains the parameter values for the deletePrestissimoEngine method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

DeletePrestissimoEngineOptions

The DeletePrestissimoEngine options.

DeletePrestissimoEngineOptions

The deletePrestissimoEngine options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

Example request

const params = {
  engineId: 'testString',
};

try {
  await watsonxDataService.deletePrestissimoEngine(params);
} catch (err) {
  console.warn(err);
}

Example request

DeletePrestissimoEngineOptions deletePrestissimoEngineOptions = new DeletePrestissimoEngineOptions.Builder()
  .engineId("testString")
  .build();

Response<Void> response = watsonxDataService.deletePrestissimoEngine(deletePrestissimoEngineOptions).execute();

Example request

response = watsonx_data_service.delete_prestissimo_engine(
  engine_id='testString',
)

Response

Status Code

204
No Content
400
Error
401
Unauthorized
404
Not found
500
Internal server error

No Sample Response

This method does not specify any sample responses.

Update details of prestissimo engine

Update details of prestissimo engine.

PATCH /prestissimo_engines/{engine_id}

(watsonxData *WatsonxDataV2) UpdatePrestissimoEngine(updatePrestissimoEngineOptions *UpdatePrestissimoEngineOptions) (result *PrestissimoEngine, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) UpdatePrestissimoEngineWithContext(ctx context.Context, updatePrestissimoEngineOptions *UpdatePrestissimoEngineOptions) (result *PrestissimoEngine, response *core.DetailedResponse, err error)

ServiceCall<PrestissimoEngine> updatePrestissimoEngine(UpdatePrestissimoEngineOptions updatePrestissimoEngineOptions)

update_prestissimo_engine(
        self,
        engine_id: str,
        body: List['JsonPatchOperation'],
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

updatePrestissimoEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.prestissimo_engine.update

Request

Instantiate the UpdatePrestissimoEngineOptions struct and set the fields to provide parameter values for the UpdatePrestissimoEngine method.

Use the UpdatePrestissimoEngineOptions.Builder to create a UpdatePrestissimoEngineOptions object that contains the parameter values for the updatePrestissimoEngine method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

Request Body

Required*

application/json-patch+jsonPrestissimoEnginePatch

Update prestissimo engine body

parameter

WithContext method only

UpdatePrestissimoEngineOptions

The UpdatePrestissimoEngine options.

UpdatePrestissimoEngineOptions

The updatePrestissimoEngine options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
body
Required*
List[JsonPatchOperation]
Update prestissimo engine body.
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
body
Required*
JsonPatchOperation[]
Update prestissimo engine body.
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

Example request

// Request models needed by this operation.

// JsonPatchOperation
const jsonPatchOperationModel = {
  op: 'add',
  path: 'testString',
};

const params = {
  engineId: 'testString',
  body: [jsonPatchOperationModel],
};

let res;
try {
  res = await watsonxDataService.updatePrestissimoEngine(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

JsonPatchOperation jsonPatchOperationModel = new JsonPatchOperation.Builder()
  .op("add")
  .path("testString")
  .build();
UpdatePrestissimoEngineOptions updatePrestissimoEngineOptions = new UpdatePrestissimoEngineOptions.Builder()
  .engineId("testString")
  .body(java.util.Arrays.asList(jsonPatchOperationModel))
  .build();

Response<PrestissimoEngine> response = watsonxDataService.updatePrestissimoEngine(updatePrestissimoEngineOptions).execute();
PrestissimoEngine prestissimoEngine = response.getResult();

System.out.println(prestissimoEngine);

Example request

json_patch_operation_model = {
  'op': 'add',
  'path': 'testString',
}

response = watsonx_data_service.update_prestissimo_engine(
  engine_id='testString',
  body=[json_patch_operation_model],
)
prestissimo_engine = response.get_result()

print(json.dumps(prestissimo_engine, indent=2))

Response

Response Body

PrestissimoEngine

EngineDetail

PrestissimoEngine

EngineDetail.

Examples:

View

PrestissimoEngine

EngineDetail.

Examples:

View

PrestissimoEngine

EngineDetail.

Examples:

View

PrestissimoEngine

EngineDetail.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "actions": [
    "update",
    "delete"
  ],
  "associated_catalogs": [
    "hive_data"
  ],
  "coordinator": {
    "node_type": "worker",
    "quantity": 1
  },
  "created_by": "<username>@<domain>.com",
  "created_on": 163788384993,
  "description": "prestissimo engine for running sql queries",
  "engine_display_name": "sampleEngine",
  "engine_id": "sampleEngine123",
  "external_host_name": "your-hostname.apps.your-domain.com",
  "group_id": "new_group_id",
  "host_name": "your-hostname.apps.your-domain.com",
  "origin": "native",
  "region": "us-south",
  "size_config": "starter",
  "status": "running",
  "status_code": 0,
  "tags": [
    "tag1",
    "tag2"
  ],
  "version": "1.2.0",
  "worker": {
    "node_type": "worker",
    "quantity": 1
  }
}

Success example

{
  "actions": [
    "update",
    "delete"
  ],
  "associated_catalogs": [
    "hive_data"
  ],
  "coordinator": {
    "node_type": "worker",
    "quantity": 1
  },
  "created_by": "<username>@<domain>.com",
  "created_on": 163788384993,
  "description": "prestissimo engine for running sql queries",
  "engine_display_name": "sampleEngine",
  "engine_id": "sampleEngine123",
  "external_host_name": "your-hostname.apps.your-domain.com",
  "group_id": "new_group_id",
  "host_name": "your-hostname.apps.your-domain.com",
  "origin": "native",
  "region": "us-south",
  "size_config": "starter",
  "status": "running",
  "status_code": 0,
  "tags": [
    "tag1",
    "tag2"
  ],
  "version": "1.2.0",
  "worker": {
    "node_type": "worker",
    "quantity": 1
  }
}

Get list of all catalogs attached a prestissimo engine

Get list of all catalogs attached a prestissimo engine.

GET /prestissimo_engines/{engine_id}/catalogs

(watsonxData *WatsonxDataV2) ListPrestissimoEngineCatalogs(listPrestissimoEngineCatalogsOptions *ListPrestissimoEngineCatalogsOptions) (result *CatalogCollection, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) ListPrestissimoEngineCatalogsWithContext(ctx context.Context, listPrestissimoEngineCatalogsOptions *ListPrestissimoEngineCatalogsOptions) (result *CatalogCollection, response *core.DetailedResponse, err error)

ServiceCall<CatalogCollection> listPrestissimoEngineCatalogs(ListPrestissimoEngineCatalogsOptions listPrestissimoEngineCatalogsOptions)

list_prestissimo_engine_catalogs(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

listPrestissimoEngineCatalogs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.prestissimo_engine_catalog.list

Request

Instantiate the ListPrestissimoEngineCatalogsOptions struct and set the fields to provide parameter values for the ListPrestissimoEngineCatalogs method.

Use the ListPrestissimoEngineCatalogsOptions.Builder to create a ListPrestissimoEngineCatalogsOptions object that contains the parameter values for the listPrestissimoEngineCatalogs method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

ListPrestissimoEngineCatalogsOptions

The ListPrestissimoEngineCatalogs options.

ListPrestissimoEngineCatalogsOptions

The listPrestissimoEngineCatalogs options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

Example request

const params = {
  engineId: 'testString',
};

let res;
try {
  res = await watsonxDataService.listPrestissimoEngineCatalogs(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

ListPrestissimoEngineCatalogsOptions listPrestissimoEngineCatalogsOptions = new ListPrestissimoEngineCatalogsOptions.Builder()
  .engineId("testString")
  .build();

Response<CatalogCollection> response = watsonxDataService.listPrestissimoEngineCatalogs(listPrestissimoEngineCatalogsOptions).execute();
CatalogCollection catalogCollection = response.getResult();

System.out.println(catalogCollection);

Example request

response = watsonx_data_service.list_prestissimo_engine_catalogs(
  engine_id='testString',
)
catalog_collection = response.get_result()

print(json.dumps(catalog_collection, indent=2))

Response

Response Body

CatalogCollection

GetCatalogs OK

CatalogCollection

GetCatalogs OK.

Examples:

View

CatalogCollection

GetCatalogs OK.

Examples:

View

CatalogCollection

GetCatalogs OK.

Examples:

View

CatalogCollection

GetCatalogs OK.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

{ "catalogs": [] }
{ "catalogs": [] }

Associate one or more catalogs to a prestissimo engine

Associate one or more catalogs to a prestissimo engine.

PUT /prestissimo_engines/{engine_id}/catalogs

(watsonxData *WatsonxDataV2) ReplacePrestissimoEngineCatalogs(replacePrestissimoEngineCatalogsOptions *ReplacePrestissimoEngineCatalogsOptions) (result *CatalogCollection, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) ReplacePrestissimoEngineCatalogsWithContext(ctx context.Context, replacePrestissimoEngineCatalogsOptions *ReplacePrestissimoEngineCatalogsOptions) (result *CatalogCollection, response *core.DetailedResponse, err error)

ServiceCall<CatalogCollection> replacePrestissimoEngineCatalogs(ReplacePrestissimoEngineCatalogsOptions replacePrestissimoEngineCatalogsOptions)

replace_prestissimo_engine_catalogs(
        self,
        engine_id: str,
        catalog_names: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

replacePrestissimoEngineCatalogs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.prestissimo_engine_catalog.add

Request

Instantiate the ReplacePrestissimoEngineCatalogsOptions struct and set the fields to provide parameter values for the ReplacePrestissimoEngineCatalogs method.

Use the ReplacePrestissimoEngineCatalogsOptions.Builder to create a ReplacePrestissimoEngineCatalogsOptions object that contains the parameter values for the replacePrestissimoEngineCatalogs method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

Query Parameters

catalog_names
Required*
string
comma separated catalog names

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-_,]+$

parameter

WithContext method only

ReplacePrestissimoEngineCatalogsOptions

The ReplacePrestissimoEngineCatalogs options.

ReplacePrestissimoEngineCatalogsOptions

The replacePrestissimoEngineCatalogs options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalog_names
Required*
str
comma separated catalog names.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_,]+$/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalogNames
Required*
string
comma separated catalog names.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_,]+$/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

Example request

const params = {
  engineId: 'testString',
  catalogNames: 'testString',
};

let res;
try {
  res = await watsonxDataService.replacePrestissimoEngineCatalogs(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

ReplacePrestissimoEngineCatalogsOptions replacePrestissimoEngineCatalogsOptions = new ReplacePrestissimoEngineCatalogsOptions.Builder()
  .engineId("testString")
  .catalogNames("testString")
  .build();

Response<CatalogCollection> response = watsonxDataService.replacePrestissimoEngineCatalogs(replacePrestissimoEngineCatalogsOptions).execute();
CatalogCollection catalogCollection = response.getResult();

System.out.println(catalogCollection);

Example request

response = watsonx_data_service.replace_prestissimo_engine_catalogs(
  engine_id='testString',
  catalog_names='testString',
)
catalog_collection = response.get_result()

print(json.dumps(catalog_collection, indent=2))

Response

Response Body

CatalogCollection

GetCatalogs OK

CatalogCollection

GetCatalogs OK.

Examples:

View

CatalogCollection

GetCatalogs OK.

Examples:

View

CatalogCollection

GetCatalogs OK.

Examples:

View

CatalogCollection

GetCatalogs OK.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

{ "catalogs": [] }
{ "catalogs": [] }

Disassociate one or more catalogs from a prestissimo engine

Disassociate one or more catalogs from a prestissimo engine.

DELETE /prestissimo_engines/{engine_id}/catalogs

(watsonxData *WatsonxDataV2) DeletePrestissimoEngineCatalogs(deletePrestissimoEngineCatalogsOptions *DeletePrestissimoEngineCatalogsOptions) (response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) DeletePrestissimoEngineCatalogsWithContext(ctx context.Context, deletePrestissimoEngineCatalogsOptions *DeletePrestissimoEngineCatalogsOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> deletePrestissimoEngineCatalogs(DeletePrestissimoEngineCatalogsOptions deletePrestissimoEngineCatalogsOptions)

delete_prestissimo_engine_catalogs(
        self,
        engine_id: str,
        catalog_names: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

deletePrestissimoEngineCatalogs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.prestissimo_engine_catalog.remove

Request

Instantiate the DeletePrestissimoEngineCatalogsOptions struct and set the fields to provide parameter values for the DeletePrestissimoEngineCatalogs method.

Use the DeletePrestissimoEngineCatalogsOptions.Builder to create a DeletePrestissimoEngineCatalogsOptions object that contains the parameter values for the deletePrestissimoEngineCatalogs method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

Query Parameters

catalog_names
Required*
string
Catalog id(s) to be stopped, comma separated

Possible values: 1 ≤ length ≤ 1000, Value must match regular expression ^[a-zA-Z0-9\-,_]+

parameter

WithContext method only

DeletePrestissimoEngineCatalogsOptions

The DeletePrestissimoEngineCatalogs options.

DeletePrestissimoEngineCatalogsOptions

The deletePrestissimoEngineCatalogs options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalog_names
Required*
str
Catalog id(s) to be stopped, comma separated.

Possible values: 1 ≤ length ≤ 1000, Value must match regular expression /^[a-zA-Z0-9\\-,_]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalogNames
Required*
string
Catalog id(s) to be stopped, comma separated.

Possible values: 1 ≤ length ≤ 1000, Value must match regular expression /^[a-zA-Z0-9\\-,_]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

Example request

const params = {
  engineId: 'testString',
  catalogNames: 'testString',
};

try {
  await watsonxDataService.deletePrestissimoEngineCatalogs(params);
} catch (err) {
  console.warn(err);
}

Example request

DeletePrestissimoEngineCatalogsOptions deletePrestissimoEngineCatalogsOptions = new DeletePrestissimoEngineCatalogsOptions.Builder()
  .engineId("testString")
  .catalogNames("testString")
  .build();

Response<Void> response = watsonxDataService.deletePrestissimoEngineCatalogs(deletePrestissimoEngineCatalogsOptions).execute();

Example request

response = watsonx_data_service.delete_prestissimo_engine_catalogs(
  engine_id='testString',
  catalog_names='testString',
)

Response

Status Code

204
No Content
400
Error
401
Unauthorized
404
Not found
500
Internal server error

No Sample Response

This method does not specify any sample responses.

Get catalog attached to a prestissimo engine

Get catalog attached to a prestissimo engine.

GET /prestissimo_engines/{engine_id}/catalogs/{catalog_id}

(watsonxData *WatsonxDataV2) GetPrestissimoEngineCatalog(getPrestissimoEngineCatalogOptions *GetPrestissimoEngineCatalogOptions) (result *Catalog, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) GetPrestissimoEngineCatalogWithContext(ctx context.Context, getPrestissimoEngineCatalogOptions *GetPrestissimoEngineCatalogOptions) (result *Catalog, response *core.DetailedResponse, err error)

ServiceCall<Catalog> getPrestissimoEngineCatalog(GetPrestissimoEngineCatalogOptions getPrestissimoEngineCatalogOptions)

get_prestissimo_engine_catalog(
        self,
        engine_id: str,
        catalog_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

getPrestissimoEngineCatalog(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.prestissimo_engine_catalog.get

Request

Instantiate the GetPrestissimoEngineCatalogOptions struct and set the fields to provide parameter values for the GetPrestissimoEngineCatalog method.

Use the GetPrestissimoEngineCatalogOptions.Builder to create a GetPrestissimoEngineCatalogOptions object that contains the parameter values for the getPrestissimoEngineCatalog method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+
catalog_id
Required*
string
catalog id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-_]+

parameter

WithContext method only

GetPrestissimoEngineCatalogOptions

The GetPrestissimoEngineCatalog options.

GetPrestissimoEngineCatalogOptions

The getPrestissimoEngineCatalog options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalog_id
Required*
str
catalog id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalogId
Required*
string
catalog id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

Example request

const params = {
  engineId: 'testString',
  catalogId: 'testString',
};

let res;
try {
  res = await watsonxDataService.getPrestissimoEngineCatalog(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

GetPrestissimoEngineCatalogOptions getPrestissimoEngineCatalogOptions = new GetPrestissimoEngineCatalogOptions.Builder()
  .engineId("testString")
  .catalogId("testString")
  .build();

Response<Catalog> response = watsonxDataService.getPrestissimoEngineCatalog(getPrestissimoEngineCatalogOptions).execute();
Catalog catalog = response.getResult();

System.out.println(catalog);

Example request

response = watsonx_data_service.get_prestissimo_engine_catalog(
  engine_id='testString',
  catalog_id='testString',
)
catalog = response.get_result()

print(json.dumps(catalog, indent=2))

Response

Response Body

Catalog

Define the catalog details

Catalog

Define the catalog details.

Examples:

View

Catalog

Define the catalog details.

Examples:

View

Catalog

Define the catalog details.

Examples:

View

Catalog

Define the catalog details.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "actions": [
    "view",
    "update",
    "delete"
  ],
  "associated_buckets": [
    "ibm_cos_bucket"
  ],
  "associated_databases": [
    "iceberg_data"
  ],
  "associated_engines": [
    "presto367"
  ],
  "catalog_name": "iceberg_data",
  "catalog_type": "iceberg",
  "created_by": "user@domain.com",
  "created_on": "1700633239",
  "description": "catalog description",
  "hostname": "1234-xyz456-abc4321.lakehouse.dev.appdomain.cloud",
  "port": "31504",
  "sync_exception": [
    "table is corrupted",
    "table metadata not there"
  ],
  "tags": [
    "tag1",
    "tag2"
  ],
  "thrift_uri": "thrift://samplehost-catalog:4354"
}

Success example

{
  "actions": [
    "view",
    "update",
    "delete"
  ],
  "associated_buckets": [
    "ibm_cos_bucket"
  ],
  "associated_databases": [
    "iceberg_data"
  ],
  "associated_engines": [
    "presto367"
  ],
  "catalog_name": "iceberg_data",
  "catalog_type": "iceberg",
  "created_by": "user@domain.com",
  "created_on": "1700633239",
  "description": "catalog description",
  "hostname": "1234-xyz456-abc4321.lakehouse.dev.appdomain.cloud",
  "port": "31504",
  "sync_exception": [
    "table is corrupted",
    "table metadata not there"
  ],
  "tags": [
    "tag1",
    "tag2"
  ],
  "thrift_uri": "thrift://samplehost-catalog:4354"
}

Pause a running prestissimo engine

Pause a running prestissimo engine.

POST /prestissimo_engines/{engine_id}/pause

(watsonxData *WatsonxDataV2) CreatePrestissimoEnginePause(createPrestissimoEnginePauseOptions *CreatePrestissimoEnginePauseOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) CreatePrestissimoEnginePauseWithContext(ctx context.Context, createPrestissimoEnginePauseOptions *CreatePrestissimoEnginePauseOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)

ServiceCall<SuccessResponse> createPrestissimoEnginePause(CreatePrestissimoEnginePauseOptions createPrestissimoEnginePauseOptions)

create_prestissimo_engine_pause(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

createPrestissimoEnginePause(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.prestissimo_engine.pause

Request

Instantiate the CreatePrestissimoEnginePauseOptions struct and set the fields to provide parameter values for the CreatePrestissimoEnginePause method.

Use the CreatePrestissimoEnginePauseOptions.Builder to create a CreatePrestissimoEnginePauseOptions object that contains the parameter values for the createPrestissimoEnginePause method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

CreatePrestissimoEnginePauseOptions

The CreatePrestissimoEnginePause options.

CreatePrestissimoEnginePauseOptions

The createPrestissimoEnginePause options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

Example request

const params = {
  engineId: 'testString',
};

let res;
try {
  res = await watsonxDataService.createPrestissimoEnginePause(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

CreatePrestissimoEnginePauseOptions createPrestissimoEnginePauseOptions = new CreatePrestissimoEnginePauseOptions.Builder()
  .engineId("testString")
  .build();

Response<SuccessResponse> response = watsonxDataService.createPrestissimoEnginePause(createPrestissimoEnginePauseOptions).execute();
SuccessResponse successResponse = response.getResult();

System.out.println(successResponse);

Example request

response = watsonx_data_service.create_prestissimo_engine_pause(
  engine_id='testString',
)
success_response = response.get_result()

print(json.dumps(success_response, indent=2))

Response

Response Body

SuccessResponse

Response of success

SuccessResponse

Response of success.

Examples:

View

SuccessResponse

Response of success.

Examples:

View

SuccessResponse

Response of success.

Examples:

View

SuccessResponse

Response of success.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "message": "Successful message",
  "message_code": "success"
}

Success example

{
  "message": "Successful message",
  "message_code": "success"
}

Explain a query statement

Explain a query statement.

POST /prestissimo_engines/{engine_id}/query_explain

(watsonxData *WatsonxDataV2) RunPrestissimoExplainStatement(runPrestissimoExplainStatementOptions *RunPrestissimoExplainStatementOptions) (result *ResultPrestissimoExplainStatement, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) RunPrestissimoExplainStatementWithContext(ctx context.Context, runPrestissimoExplainStatementOptions *RunPrestissimoExplainStatementOptions) (result *ResultPrestissimoExplainStatement, response *core.DetailedResponse, err error)

ServiceCall<ResultPrestissimoExplainStatement> runPrestissimoExplainStatement(RunPrestissimoExplainStatementOptions runPrestissimoExplainStatementOptions)

run_prestissimo_explain_statement(
        self,
        engine_id: str,
        statement: str,
        *,
        format: Optional[str] = None,
        type: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

runPrestissimoExplainStatement(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.query_explain.create

Request

Instantiate the RunPrestissimoExplainStatementOptions struct and set the fields to provide parameter values for the RunPrestissimoExplainStatement method.

Use the RunPrestissimoExplainStatementOptions.Builder to create a RunPrestissimoExplainStatementOptions object that contains the parameter values for the runPrestissimoExplainStatement method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
Engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

Request Body

Required*

ExplainPrototype

Request body

parameter

WithContext method only

RunPrestissimoExplainStatementOptions

The RunPrestissimoExplainStatement options.

RunPrestissimoExplainStatementOptions

The runPrestissimoExplainStatement options.

parameters

engine_id
Required*
str
Engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
statement
Required*
str
Presto query to determine explain plan.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
format
str
Format.

Allowable values: [,text,graphviz,json]
Possible values: 0 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
type
str
Type.

Allowable values: [,logical,distributed,validate,io]
Possible values: 0 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
Engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
statement
Required*
string
Presto query to determine explain plan.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
format
string
Format.

Allowable values: [,text,graphviz,json]
Possible values: 0 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
type
string
Type.

Allowable values: [,logical,distributed,validate,io]
Possible values: 0 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

Example request

const params = {
  engineId: 'testString',
  statement: 'show schemas in catalog_name',
};

let res;
try {
  res = await watsonxDataService.runPrestissimoExplainStatement(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

RunPrestissimoExplainStatementOptions runPrestissimoExplainStatementOptions = new RunPrestissimoExplainStatementOptions.Builder()
  .engineId("testString")
  .statement("show schemas in catalog_name")
  .build();

Response<ResultPrestissimoExplainStatement> response = watsonxDataService.runPrestissimoExplainStatement(runPrestissimoExplainStatementOptions).execute();
ResultPrestissimoExplainStatement resultPrestissimoExplainStatement = response.getResult();

System.out.println(resultPrestissimoExplainStatement);

Example request

response = watsonx_data_service.run_prestissimo_explain_statement(
  engine_id='testString',
  statement='show schemas in catalog_name',
)
result_prestissimo_explain_statement = response.get_result()

print(json.dumps(result_prestissimo_explain_statement, indent=2))

Response

Response Body

ResultPrestissimoExplainStatement

ExplainStatement OK

ResultPrestissimoExplainStatement

ExplainStatement OK.

Examples:

View

ResultPrestissimoExplainStatement

ExplainStatement OK.

Examples:

View

ResultPrestissimoExplainStatement

ExplainStatement OK.

Examples:

View

ResultPrestissimoExplainStatement

ExplainStatement OK.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

{ "result": "explain statement" }
{ "result": "explain statement" }

Return query metrics after query is complete

Return query metrics after query is complete.

POST /prestissimo_engines/{engine_id}/query_explain_analyze

(watsonxData *WatsonxDataV2) RunPrestissimoExplainAnalyzeStatement(runPrestissimoExplainAnalyzeStatementOptions *RunPrestissimoExplainAnalyzeStatementOptions) (result *ResultRunPrestissimoExplainAnalyzeStatement, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) RunPrestissimoExplainAnalyzeStatementWithContext(ctx context.Context, runPrestissimoExplainAnalyzeStatementOptions *RunPrestissimoExplainAnalyzeStatementOptions) (result *ResultRunPrestissimoExplainAnalyzeStatement, response *core.DetailedResponse, err error)

ServiceCall<ResultRunPrestissimoExplainAnalyzeStatement> runPrestissimoExplainAnalyzeStatement(RunPrestissimoExplainAnalyzeStatementOptions runPrestissimoExplainAnalyzeStatementOptions)

run_prestissimo_explain_analyze_statement(
        self,
        engine_id: str,
        statement: str,
        *,
        verbose: Optional[bool] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

runPrestissimoExplainAnalyzeStatement(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.query_explain_analyze.create

Request

Instantiate the RunPrestissimoExplainAnalyzeStatementOptions struct and set the fields to provide parameter values for the RunPrestissimoExplainAnalyzeStatement method.

Use the RunPrestissimoExplainAnalyzeStatementOptions.Builder to create a RunPrestissimoExplainAnalyzeStatementOptions object that contains the parameter values for the runPrestissimoExplainAnalyzeStatement method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
Engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

Request Body

Required*

ExplainAnalyzePrototype

Request body

parameter

WithContext method only

RunPrestissimoExplainAnalyzeStatementOptions

The RunPrestissimoExplainAnalyzeStatement options.

RunPrestissimoExplainAnalyzeStatementOptions

The runPrestissimoExplainAnalyzeStatement options.

parameters

engine_id
Required*
str
Engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
statement
Required*
str
Presto query to show explain analyze.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
verbose
bool
Verbose.

Examples:
value
_source
_lines
_html
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
Engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
statement
Required*
string
Presto query to show explain analyze.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
verbose
boolean
Verbose.

Examples:
value
_source
_lines
_html
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

Example request

const params = {
  engineId: 'testString',
  statement: 'show schemas in catalog_name',
};

let res;
try {
  res = await watsonxDataService.runPrestissimoExplainAnalyzeStatement(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

RunPrestissimoExplainAnalyzeStatementOptions runPrestissimoExplainAnalyzeStatementOptions = new RunPrestissimoExplainAnalyzeStatementOptions.Builder()
  .engineId("testString")
  .statement("show schemas in catalog_name")
  .build();

Response<ResultRunPrestissimoExplainAnalyzeStatement> response = watsonxDataService.runPrestissimoExplainAnalyzeStatement(runPrestissimoExplainAnalyzeStatementOptions).execute();
ResultRunPrestissimoExplainAnalyzeStatement resultRunPrestissimoExplainAnalyzeStatement = response.getResult();

System.out.println(resultRunPrestissimoExplainAnalyzeStatement);

Example request

response = watsonx_data_service.run_prestissimo_explain_analyze_statement(
  engine_id='testString',
  statement='show schemas in catalog_name',
)
result_run_prestissimo_explain_analyze_statement = response.get_result()

print(json.dumps(result_run_prestissimo_explain_analyze_statement, indent=2))

Response

Response Body

ResultRunPrestissimoExplainAnalyzeStatement

explainAnalyzeStatement OK

ResultRunPrestissimoExplainAnalyzeStatement

explainAnalyzeStatement OK.

Examples:

View

ResultRunPrestissimoExplainAnalyzeStatement

explainAnalyzeStatement OK.

Examples:

View

ResultRunPrestissimoExplainAnalyzeStatement

explainAnalyzeStatement OK.

Examples:

View

ResultRunPrestissimoExplainAnalyzeStatement

explainAnalyzeStatement OK.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

{ "result": "explain statement" }
{ "result": "explain statement" }

Restart an existing prestissimo engine

Restart an existing prestissimo engine.

POST /prestissimo_engines/{engine_id}/restart

(watsonxData *WatsonxDataV2) CreatePrestissimoEngineRestart(createPrestissimoEngineRestartOptions *CreatePrestissimoEngineRestartOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) CreatePrestissimoEngineRestartWithContext(ctx context.Context, createPrestissimoEngineRestartOptions *CreatePrestissimoEngineRestartOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)

ServiceCall<SuccessResponse> createPrestissimoEngineRestart(CreatePrestissimoEngineRestartOptions createPrestissimoEngineRestartOptions)

create_prestissimo_engine_restart(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

createPrestissimoEngineRestart(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.prestissimo_engine.refresh

Request

Instantiate the CreatePrestissimoEngineRestartOptions struct and set the fields to provide parameter values for the CreatePrestissimoEngineRestart method.

Use the CreatePrestissimoEngineRestartOptions.Builder to create a CreatePrestissimoEngineRestartOptions object that contains the parameter values for the createPrestissimoEngineRestart method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

CreatePrestissimoEngineRestartOptions

The CreatePrestissimoEngineRestart options.

CreatePrestissimoEngineRestartOptions

The createPrestissimoEngineRestart options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

Example request

const params = {
  engineId: 'testString',
};

let res;
try {
  res = await watsonxDataService.createPrestissimoEngineRestart(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

CreatePrestissimoEngineRestartOptions createPrestissimoEngineRestartOptions = new CreatePrestissimoEngineRestartOptions.Builder()
  .engineId("testString")
  .build();

Response<SuccessResponse> response = watsonxDataService.createPrestissimoEngineRestart(createPrestissimoEngineRestartOptions).execute();
SuccessResponse successResponse = response.getResult();

System.out.println(successResponse);

Example request

response = watsonx_data_service.create_prestissimo_engine_restart(
  engine_id='testString',
)
success_response = response.get_result()

print(json.dumps(success_response, indent=2))

Response

Response Body

SuccessResponse

Response of success

SuccessResponse

Response of success.

Examples:

View

SuccessResponse

Response of success.

Examples:

View

SuccessResponse

Response of success.

Examples:

View

SuccessResponse

Response of success.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "message": "Successful message",
  "message_code": "success"
}

Success example

{
  "message": "Successful message",
  "message_code": "success"
}

Resume a paused prestissimo engine

Resume a paused prestissimo engine.

POST /prestissimo_engines/{engine_id}/resume

(watsonxData *WatsonxDataV2) CreatePrestissimoEngineResume(createPrestissimoEngineResumeOptions *CreatePrestissimoEngineResumeOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) CreatePrestissimoEngineResumeWithContext(ctx context.Context, createPrestissimoEngineResumeOptions *CreatePrestissimoEngineResumeOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)

ServiceCall<SuccessResponse> createPrestissimoEngineResume(CreatePrestissimoEngineResumeOptions createPrestissimoEngineResumeOptions)

create_prestissimo_engine_resume(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

createPrestissimoEngineResume(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.prestissimo_engine.resume

Request

Instantiate the CreatePrestissimoEngineResumeOptions struct and set the fields to provide parameter values for the CreatePrestissimoEngineResume method.

Use the CreatePrestissimoEngineResumeOptions.Builder to create a CreatePrestissimoEngineResumeOptions object that contains the parameter values for the createPrestissimoEngineResume method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

CreatePrestissimoEngineResumeOptions

The CreatePrestissimoEngineResume options.

CreatePrestissimoEngineResumeOptions

The createPrestissimoEngineResume options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

Example request

const params = {
  engineId: 'testString',
};

let res;
try {
  res = await watsonxDataService.createPrestissimoEngineResume(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

CreatePrestissimoEngineResumeOptions createPrestissimoEngineResumeOptions = new CreatePrestissimoEngineResumeOptions.Builder()
  .engineId("testString")
  .build();

Response<SuccessResponse> response = watsonxDataService.createPrestissimoEngineResume(createPrestissimoEngineResumeOptions).execute();
SuccessResponse successResponse = response.getResult();

System.out.println(successResponse);

Example request

response = watsonx_data_service.create_prestissimo_engine_resume(
  engine_id='testString',
)
success_response = response.get_result()

print(json.dumps(success_response, indent=2))

Response

Response Body

SuccessResponse

Response of success

SuccessResponse

Response of success.

Examples:

View

SuccessResponse

Response of success.

Examples:

View

SuccessResponse

Response of success.

Examples:

View

SuccessResponse

Response of success.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "message": "Successful message",
  "message_code": "success"
}

Success example

{
  "message": "Successful message",
  "message_code": "success"
}

Scale an existing prestissimo engine

Scale an existing prestissimo engine.

POST /prestissimo_engines/{engine_id}/scale

(watsonxData *WatsonxDataV2) CreatePrestissimoEngineScale(createPrestissimoEngineScaleOptions *CreatePrestissimoEngineScaleOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) CreatePrestissimoEngineScaleWithContext(ctx context.Context, createPrestissimoEngineScaleOptions *CreatePrestissimoEngineScaleOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)

ServiceCall<SuccessResponse> createPrestissimoEngineScale(CreatePrestissimoEngineScaleOptions createPrestissimoEngineScaleOptions)

create_prestissimo_engine_scale(
        self,
        engine_id: str,
        *,
        coordinator: Optional['PrestissimoNodeDescriptionBody'] = None,
        worker: Optional['PrestissimoNodeDescriptionBody'] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

createPrestissimoEngineScale(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.prestissimo_engine.scale

Request

Instantiate the CreatePrestissimoEngineScaleOptions struct and set the fields to provide parameter values for the CreatePrestissimoEngineScale method.

Use the CreatePrestissimoEngineScaleOptions.Builder to create a CreatePrestissimoEngineScaleOptions object that contains the parameter values for the createPrestissimoEngineScale method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

Request Body

Required*

PrestissimoEngineScale

Scale Engine Body

parameter

WithContext method only

CreatePrestissimoEngineScaleOptions

The CreatePrestissimoEngineScale options.

CreatePrestissimoEngineScaleOptions

The createPrestissimoEngineScale options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
coordinator
Node details.
worker
Node details.
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
coordinator
Node details.
worker
Node details.
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

Example request

const params = {
  engineId: 'testString',
};

let res;
try {
  res = await watsonxDataService.createPrestissimoEngineScale(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

CreatePrestissimoEngineScaleOptions createPrestissimoEngineScaleOptions = new CreatePrestissimoEngineScaleOptions.Builder()
  .engineId("testString")
  .build();

Response<SuccessResponse> response = watsonxDataService.createPrestissimoEngineScale(createPrestissimoEngineScaleOptions).execute();
SuccessResponse successResponse = response.getResult();

System.out.println(successResponse);

Example request

response = watsonx_data_service.create_prestissimo_engine_scale(
  engine_id='testString',
)
success_response = response.get_result()

print(json.dumps(success_response, indent=2))

Response

Response Body

SuccessResponse

Response of success

SuccessResponse

Response of success.

Examples:

View

SuccessResponse

Response of success.

Examples:

View

SuccessResponse

Response of success.

Examples:

View

SuccessResponse

Response of success.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "message": "Successful message",
  "message_code": "success"
}

Success example

{
  "message": "Successful message",
  "message_code": "success"
}

Get list of all presto engines

Get list of all presto engines.

GET /presto_engines

(watsonxData *WatsonxDataV2) ListPrestoEngines(listPrestoEnginesOptions *ListPrestoEnginesOptions) (result *PrestoEngineCollection, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) ListPrestoEnginesWithContext(ctx context.Context, listPrestoEnginesOptions *ListPrestoEnginesOptions) (result *PrestoEngineCollection, response *core.DetailedResponse, err error)

ServiceCall<PrestoEngineCollection> listPrestoEngines(ListPrestoEnginesOptions listPrestoEnginesOptions)

list_presto_engines(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

listPrestoEngines(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.presto_engine.list

Request

Instantiate the ListPrestoEnginesOptions struct and set the fields to provide parameter values for the ListPrestoEngines method.

Use the ListPrestoEnginesOptions.Builder to create a ListPrestoEnginesOptions object that contains the parameter values for the listPrestoEngines method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

parameter

WithContext method only

ListPrestoEnginesOptions

The ListPrestoEngines options.

ListPrestoEnginesOptions

The listPrestoEngines options.

parameters

auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X GET -H "content-type: application/json" -H "AuthInstanceId: {instance id}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/presto_engines"

Example request

let res;
try {
  res = await watsonxDataService.listPrestoEngines({});
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

ListPrestoEnginesOptions listPrestoEnginesOptions = new ListPrestoEnginesOptions.Builder()
  .build();

Response<PrestoEngineCollection> response = watsonxDataService.listPrestoEngines(listPrestoEnginesOptions).execute();
PrestoEngineCollection prestoEngineCollection = response.getResult();

System.out.println(prestoEngineCollection);

Example request

response = watsonx_data_service.list_presto_engines()
presto_engine_collection = response.get_result()

print(json.dumps(presto_engine_collection, indent=2))

Response

Response Body

PrestoEngineCollection

List Presto engines

PrestoEngineCollection

List Presto engines.

Examples:

View

PrestoEngineCollection

List Presto engines.

Examples:

View

PrestoEngineCollection

List Presto engines.

Examples:

View

PrestoEngineCollection

List Presto engines.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "presto_engines": [
    {
      "actions": [
        "view",
        "use",
        "update",
        "select",
        "access_ui",
        "associate",
        "disassociate",
        "restart",
        "pause",
        "resume",
        "grant",
        "revoke",
        "delete",
        "create",
        "scale"
      ],
      "associated_catalogs": [
        "iceberg_data",
        "hive_data"
      ],
      "build_version": "1.1.0.0.0",
      "coordinator": {
        "node_type": "bx2.4x16",
        "quantity": 1
      },
      "engine_display_name": "starter",
      "engine_id": "presto511",
      "external_host_name": "your-hostname.apps.your-domain.com",
      "group_id": "presto511",
      "host_name": "1234-xyz456-abc4321.databases.appdomain.cloud",
      "origin": "native",
      "port": 30156,
      "size_config": "starter",
      "status": "running",
      "status_code": 0,
      "tags": [
        "tag1",
        "tag2"
      ],
      "type": "presto",
      "version": "v0.282",
      "worker": {
        "node_type": "bx2.4x16",
        "quantity": 1
      }
    }
  ]
}

Success example

{
  "presto_engines": [
    {
      "actions": [
        "view",
        "use",
        "update",
        "select",
        "access_ui",
        "associate",
        "disassociate",
        "restart",
        "pause",
        "resume",
        "grant",
        "revoke",
        "delete",
        "create",
        "scale"
      ],
      "associated_catalogs": [
        "iceberg_data",
        "hive_data"
      ],
      "build_version": "1.1.0.0.0",
      "coordinator": {
        "node_type": "bx2.4x16",
        "quantity": 1
      },
      "engine_display_name": "starter",
      "engine_id": "presto511",
      "external_host_name": "your-hostname.apps.your-domain.com",
      "group_id": "presto511",
      "host_name": "1234-xyz456-abc4321.databases.appdomain.cloud",
      "origin": "native",
      "port": 30156,
      "size_config": "starter",
      "status": "running",
      "status_code": 0,
      "tags": [
        "tag1",
        "tag2"
      ],
      "type": "presto",
      "version": "v0.282",
      "worker": {
        "node_type": "bx2.4x16",
        "quantity": 1
      }
    }
  ]
}

Create a new presto engine

Create a new presto engine.

POST /presto_engines

(watsonxData *WatsonxDataV2) CreatePrestoEngine(createPrestoEngineOptions *CreatePrestoEngineOptions) (result *PrestoEngine, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) CreatePrestoEngineWithContext(ctx context.Context, createPrestoEngineOptions *CreatePrestoEngineOptions) (result *PrestoEngine, response *core.DetailedResponse, err error)

ServiceCall<PrestoEngine> createPrestoEngine(CreatePrestoEngineOptions createPrestoEngineOptions)

create_presto_engine(
        self,
        origin: str,
        type: str,
        *,
        associated_catalogs: Optional[List[str]] = None,
        description: Optional[str] = None,
        engine_details: Optional['EngineDetailsBody'] = None,
        engine_display_name: Optional[str] = None,
        region: Optional[str] = None,
        tags: Optional[List[str]] = None,
        version: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

createPrestoEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.presto_engine.create

Request

Instantiate the CreatePrestoEngineOptions struct and set the fields to provide parameter values for the CreatePrestoEngine method.

Use the CreatePrestoEngineOptions.Builder to create a CreatePrestoEngineOptions object that contains the parameter values for the createPrestoEngine method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Request Body

Required*

PrestoEnginePrototype

Create Engine Body

parameter

WithContext method only

CreatePrestoEngineOptions

The CreatePrestoEngine options.

CreatePrestoEngineOptions

The createPrestoEngine options.

parameters

origin
Required*
str
Origin - created or registered.

Allowable values: [native,external,discover]
Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
type
Required*
str
Engine type presto.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
associated_catalogs
List[str]
Associated catalogs.

Possible values: 0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
description
str
Engine description.

Possible values: 1 ≤ length ≤ 1000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
engine_details
Node details.
engine_display_name
str
Engine display name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
region
str
Region (cloud).

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
tags
List[str]
Tags.

Possible values: 0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
version
str
Version like 0.278 for presto or else.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

origin
Required*
string
Origin - created or registered.

Allowable values: [native,external,discover]
Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
type
Required*
string
Engine type presto.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
associatedCatalogs
string[]
Associated catalogs.

Possible values: 0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
description
string
Engine description.

Possible values: 1 ≤ length ≤ 1000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
engineDetails
Node details.
engineDisplayName
string
Engine display name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
region
string
Region (cloud).

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
tags
string[]
Tags.

Possible values: 0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
version
string
Version like 0.278 for presto or else.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'POST' \'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/presto_engines' \-H 'accept: application/json' \-H 'Content-Type: application/json' \-d '{  "associated_catalogs": [    "iceberg_data",    "hive_data"  ],  "description": "presto engine description",  "engine_details": {    "api_key": "<api_key>",    "connection_string": "1.2.3.4",    "coordinator": {      "node_type": "worker",      "quantity": 0    },    "instance_id": "instance_id",    "managed_by": "fully/self",    "size_config": "starter",    "worker": {      "node_type": "worker",      "quantity": 0    }  },  "engine_display_name": "sampleEngine",  "first_time_use": true,  "origin": "native",  "region": "us-south",  "tags": [    "tag1",    "tag2"  ],  "type": "presto",  "version": "1.2.3"}'

Example request

const params = {
  origin: 'native',
  type: 'presto',
};

let res;
try {
  res = await watsonxDataService.createPrestoEngine(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

CreatePrestoEngineOptions createPrestoEngineOptions = new CreatePrestoEngineOptions.Builder()
  .origin("native")
  .type("presto")
  .build();

Response<PrestoEngine> response = watsonxDataService.createPrestoEngine(createPrestoEngineOptions).execute();
PrestoEngine prestoEngine = response.getResult();

System.out.println(prestoEngine);

Example request

response = watsonx_data_service.create_presto_engine(
  origin='native',
  type='presto',
)
presto_engine = response.get_result()

print(json.dumps(presto_engine, indent=2))

Response

Response Body

PrestoEngine

EngineDetail

PrestoEngine

EngineDetail.

Examples:

View

PrestoEngine

EngineDetail.

Examples:

View

PrestoEngine

EngineDetail.

Examples:

View

PrestoEngine

EngineDetail.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "actions": [
    "view",
    "use",
    "update",
    "select",
    "access_ui",
    "associate",
    "disassociate",
    "restart",
    "pause",
    "resume",
    "grant",
    "revoke",
    "delete",
    "create",
    "scale"
  ],
  "associated_catalogs": [
    "iceberg_data",
    "hive_data"
  ],
  "build_version": "1.1.0.0.0",
  "coordinator": {
    "node_type": "bx2.4x16",
    "quantity": 1
  },
  "engine_display_name": "starter",
  "engine_id": "presto511",
  "external_host_name": "your-hostname.apps.your-domain.com",
  "group_id": "presto511",
  "host_name": "1234-xyz456-abc4321.databases.appdomain.cloud",
  "origin": "native",
  "port": 30156,
  "size_config": "starter",
  "status": "running",
  "status_code": 0,
  "tags": [
    "tag1",
    "tag2"
  ],
  "type": "presto",
  "version": "v0.282",
  "worker": {
    "node_type": "bx2.4x16",
    "quantity": 1
  }
}

Success example

{
  "actions": [
    "view",
    "use",
    "update",
    "select",
    "access_ui",
    "associate",
    "disassociate",
    "restart",
    "pause",
    "resume",
    "grant",
    "revoke",
    "delete",
    "create",
    "scale"
  ],
  "associated_catalogs": [
    "iceberg_data",
    "hive_data"
  ],
  "build_version": "1.1.0.0.0",
  "coordinator": {
    "node_type": "bx2.4x16",
    "quantity": 1
  },
  "engine_display_name": "starter",
  "engine_id": "presto511",
  "external_host_name": "your-hostname.apps.your-domain.com",
  "group_id": "presto511",
  "host_name": "1234-xyz456-abc4321.databases.appdomain.cloud",
  "origin": "native",
  "port": 30156,
  "size_config": "starter",
  "status": "running",
  "status_code": 0,
  "tags": [
    "tag1",
    "tag2"
  ],
  "type": "presto",
  "version": "v0.282",
  "worker": {
    "node_type": "bx2.4x16",
    "quantity": 1
  }
}

Get details of one presto engine

Get details of one presto engine.

GET /presto_engines/{engine_id}

(watsonxData *WatsonxDataV2) GetPrestoEngine(getPrestoEngineOptions *GetPrestoEngineOptions) (result *PrestoEngine, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) GetPrestoEngineWithContext(ctx context.Context, getPrestoEngineOptions *GetPrestoEngineOptions) (result *PrestoEngine, response *core.DetailedResponse, err error)

ServiceCall<PrestoEngine> getPrestoEngine(GetPrestoEngineOptions getPrestoEngineOptions)

get_presto_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

getPrestoEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.presto_engine.get

Request

Instantiate the GetPrestoEngineOptions struct and set the fields to provide parameter values for the GetPrestoEngine method.

Use the GetPrestoEngineOptions.Builder to create a GetPrestoEngineOptions object that contains the parameter values for the getPrestoEngine method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

GetPrestoEngineOptions

The GetPrestoEngine options.

GetPrestoEngineOptions

The getPrestoEngine options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'GET' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/presto_engines/{engine_id}' -H 'accept: application/json' -H "AuthInstanceId: {instance id}" 

Example request

const params = {
  engineId: 'testString',
};

let res;
try {
  res = await watsonxDataService.getPrestoEngine(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

GetPrestoEngineOptions getPrestoEngineOptions = new GetPrestoEngineOptions.Builder()
  .engineId("testString")
  .build();

Response<PrestoEngine> response = watsonxDataService.getPrestoEngine(getPrestoEngineOptions).execute();
PrestoEngine prestoEngine = response.getResult();

System.out.println(prestoEngine);

Example request

response = watsonx_data_service.get_presto_engine(
  engine_id='testString',
)
presto_engine = response.get_result()

print(json.dumps(presto_engine, indent=2))

Response

Response Body

PrestoEngine

EngineDetail

PrestoEngine

EngineDetail.

Examples:

View

PrestoEngine

EngineDetail.

Examples:

View

PrestoEngine

EngineDetail.

Examples:

View

PrestoEngine

EngineDetail.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "actions": [
    "view",
    "use",
    "update",
    "select",
    "access_ui",
    "associate",
    "disassociate",
    "restart",
    "pause",
    "resume",
    "grant",
    "revoke",
    "delete",
    "create",
    "scale"
  ],
  "associated_catalogs": [
    "iceberg_data",
    "hive_data"
  ],
  "build_version": "1.1.0.0.0",
  "coordinator": {
    "node_type": "bx2.4x16",
    "quantity": 1
  },
  "engine_display_name": "starter",
  "engine_id": "presto511",
  "external_host_name": "your-hostname.apps.your-domain.com",
  "group_id": "presto511",
  "host_name": "1234-xyz456-abc4321.databases.appdomain.cloud",
  "origin": "native",
  "port": 30156,
  "size_config": "starter",
  "status": "running",
  "status_code": 0,
  "tags": [
    "tag1",
    "tag2"
  ],
  "type": "presto",
  "version": "v0.282",
  "worker": {
    "node_type": "bx2.4x16",
    "quantity": 1
  }
}

Success example

{
  "actions": [
    "view",
    "use",
    "update",
    "select",
    "access_ui",
    "associate",
    "disassociate",
    "restart",
    "pause",
    "resume",
    "grant",
    "revoke",
    "delete",
    "create",
    "scale"
  ],
  "associated_catalogs": [
    "iceberg_data",
    "hive_data"
  ],
  "build_version": "1.1.0.0.0",
  "coordinator": {
    "node_type": "bx2.4x16",
    "quantity": 1
  },
  "engine_display_name": "starter",
  "engine_id": "presto511",
  "external_host_name": "your-hostname.apps.your-domain.com",
  "group_id": "presto511",
  "host_name": "1234-xyz456-abc4321.databases.appdomain.cloud",
  "origin": "native",
  "port": 30156,
  "size_config": "starter",
  "status": "running",
  "status_code": 0,
  "tags": [
    "tag1",
    "tag2"
  ],
  "type": "presto",
  "version": "v0.282",
  "worker": {
    "node_type": "bx2.4x16",
    "quantity": 1
  }
}

Delete a presto engine

Delete a presto engine.

DELETE /presto_engines/{engine_id}

(watsonxData *WatsonxDataV2) DeleteEngine(deleteEngineOptions *DeleteEngineOptions) (response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) DeleteEngineWithContext(ctx context.Context, deleteEngineOptions *DeleteEngineOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> deleteEngine(DeleteEngineOptions deleteEngineOptions)

delete_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

deleteEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.presto_engine.delete

Request

Instantiate the DeleteEngineOptions struct and set the fields to provide parameter values for the DeleteEngine method.

Use the DeleteEngineOptions.Builder to create a DeleteEngineOptions object that contains the parameter values for the deleteEngine method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

DeleteEngineOptions

The DeleteEngine options.

DeleteEngineOptions

The deleteEngine options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'DELETE' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/presto_engines/{engine_id}' -H 'accept: */*' -H "AuthInstanceId: {instance id}"

Example request

const params = {
  engineId: 'testString',
};

try {
  await watsonxDataService.deleteEngine(params);
} catch (err) {
  console.warn(err);
}

Example request

DeleteEngineOptions deleteEngineOptions = new DeleteEngineOptions.Builder()
  .engineId("testString")
  .build();

Response<Void> response = watsonxDataService.deleteEngine(deleteEngineOptions).execute();

Example request

response = watsonx_data_service.delete_engine(
  engine_id='testString',
)

Response

Status Code

204
No Content
400
Error
401
Unauthorized
404
Not found
500
Internal server error

No Sample Response

This method does not specify any sample responses.

Update details of presto engine

Update details of presto engine.

PATCH /presto_engines/{engine_id}

(watsonxData *WatsonxDataV2) UpdatePrestoEngine(updatePrestoEngineOptions *UpdatePrestoEngineOptions) (result *PrestoEngine, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) UpdatePrestoEngineWithContext(ctx context.Context, updatePrestoEngineOptions *UpdatePrestoEngineOptions) (result *PrestoEngine, response *core.DetailedResponse, err error)

ServiceCall<PrestoEngine> updatePrestoEngine(UpdatePrestoEngineOptions updatePrestoEngineOptions)

update_presto_engine(
        self,
        engine_id: str,
        body: List['JsonPatchOperation'],
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

updatePrestoEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.presto_engine.update

Request

Instantiate the UpdatePrestoEngineOptions struct and set the fields to provide parameter values for the UpdatePrestoEngine method.

Use the UpdatePrestoEngineOptions.Builder to create a UpdatePrestoEngineOptions object that contains the parameter values for the updatePrestoEngine method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

Request Body

Required*

application/json-patch+jsonPrestoEnginePatch

Update Engine Body

parameter

WithContext method only

UpdatePrestoEngineOptions

The UpdatePrestoEngine options.

UpdatePrestoEngineOptions

The updatePrestoEngine options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
body
Required*
List[JsonPatchOperation]
Update Engine Body.
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
body
Required*
JsonPatchOperation[]
Update Engine Body.
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'PATCH' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/presto_engines/{engine_id}' -H 'accept: application/json' -H 'Content-Type: application/json-patch+json' -H "AuthInstanceId: {instance id}" -d '{  "description": "updated description for presto engine",  "engine_display_name": "sampleEngine",  "tags": [    "tag1",    "tag2"  ]}'

Example request

// Request models needed by this operation.

// JsonPatchOperation
const jsonPatchOperationModel = {
  op: 'add',
  path: 'testString',
};

const params = {
  engineId: 'testString',
  body: [jsonPatchOperationModel],
};

let res;
try {
  res = await watsonxDataService.updatePrestoEngine(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

JsonPatchOperation jsonPatchOperationModel = new JsonPatchOperation.Builder()
  .op("add")
  .path("testString")
  .build();
UpdatePrestoEngineOptions updatePrestoEngineOptions = new UpdatePrestoEngineOptions.Builder()
  .engineId("testString")
  .body(java.util.Arrays.asList(jsonPatchOperationModel))
  .build();

Response<PrestoEngine> response = watsonxDataService.updatePrestoEngine(updatePrestoEngineOptions).execute();
PrestoEngine prestoEngine = response.getResult();

System.out.println(prestoEngine);

Example request

json_patch_operation_model = {
  'op': 'add',
  'path': 'testString',
}

response = watsonx_data_service.update_presto_engine(
  engine_id='testString',
  body=[json_patch_operation_model],
)
presto_engine = response.get_result()

print(json.dumps(presto_engine, indent=2))

Response

Response Body

PrestoEngine

EngineDetail

PrestoEngine

EngineDetail.

Examples:

View

PrestoEngine

EngineDetail.

Examples:

View

PrestoEngine

EngineDetail.

Examples:

View

PrestoEngine

EngineDetail.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "actions": [
    "view",
    "use",
    "update",
    "select",
    "access_ui",
    "associate",
    "disassociate",
    "restart",
    "pause",
    "resume",
    "grant",
    "revoke",
    "delete",
    "create",
    "scale"
  ],
  "associated_catalogs": [
    "iceberg_data",
    "hive_data"
  ],
  "build_version": "1.1.0.0.0",
  "coordinator": {
    "node_type": "bx2.4x16",
    "quantity": 1
  },
  "engine_display_name": "starter",
  "engine_id": "presto511",
  "external_host_name": "your-hostname.apps.your-domain.com",
  "group_id": "presto511",
  "host_name": "1234-xyz456-abc4321.databases.appdomain.cloud",
  "origin": "native",
  "port": 30156,
  "size_config": "starter",
  "status": "running",
  "status_code": 0,
  "tags": [
    "tag1",
    "tag2"
  ],
  "type": "presto",
  "version": "v0.282",
  "worker": {
    "node_type": "bx2.4x16",
    "quantity": 1
  }
}

Success example

{
  "actions": [
    "view",
    "use",
    "update",
    "select",
    "access_ui",
    "associate",
    "disassociate",
    "restart",
    "pause",
    "resume",
    "grant",
    "revoke",
    "delete",
    "create",
    "scale"
  ],
  "associated_catalogs": [
    "iceberg_data",
    "hive_data"
  ],
  "build_version": "1.1.0.0.0",
  "coordinator": {
    "node_type": "bx2.4x16",
    "quantity": 1
  },
  "engine_display_name": "starter",
  "engine_id": "presto511",
  "external_host_name": "your-hostname.apps.your-domain.com",
  "group_id": "presto511",
  "host_name": "1234-xyz456-abc4321.databases.appdomain.cloud",
  "origin": "native",
  "port": 30156,
  "size_config": "starter",
  "status": "running",
  "status_code": 0,
  "tags": [
    "tag1",
    "tag2"
  ],
  "type": "presto",
  "version": "v0.282",
  "worker": {
    "node_type": "bx2.4x16",
    "quantity": 1
  }
}

Get list of all catalogs attached to a presto engine

Get list of all catalogs attached to a presto engine.

GET /presto_engines/{engine_id}/catalogs

(watsonxData *WatsonxDataV2) ListPrestoEngineCatalogs(listPrestoEngineCatalogsOptions *ListPrestoEngineCatalogsOptions) (result *CatalogCollection, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) ListPrestoEngineCatalogsWithContext(ctx context.Context, listPrestoEngineCatalogsOptions *ListPrestoEngineCatalogsOptions) (result *CatalogCollection, response *core.DetailedResponse, err error)

ServiceCall<CatalogCollection> listPrestoEngineCatalogs(ListPrestoEngineCatalogsOptions listPrestoEngineCatalogsOptions)

list_presto_engine_catalogs(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

listPrestoEngineCatalogs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.presto_engine_catalog.list

Request

Instantiate the ListPrestoEngineCatalogsOptions struct and set the fields to provide parameter values for the ListPrestoEngineCatalogs method.

Use the ListPrestoEngineCatalogsOptions.Builder to create a ListPrestoEngineCatalogsOptions object that contains the parameter values for the listPrestoEngineCatalogs method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

ListPrestoEngineCatalogsOptions

The ListPrestoEngineCatalogs options.

ListPrestoEngineCatalogsOptions

The listPrestoEngineCatalogs options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'GET' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/presto_engines/{engine_id}/catalogs' -H 'accept: application/json' -H "AuthInstanceId: {instance id}"

Example request

const params = {
  engineId: 'testString',
};

let res;
try {
  res = await watsonxDataService.listPrestoEngineCatalogs(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

ListPrestoEngineCatalogsOptions listPrestoEngineCatalogsOptions = new ListPrestoEngineCatalogsOptions.Builder()
  .engineId("testString")
  .build();

Response<CatalogCollection> response = watsonxDataService.listPrestoEngineCatalogs(listPrestoEngineCatalogsOptions).execute();
CatalogCollection catalogCollection = response.getResult();

System.out.println(catalogCollection);

Example request

response = watsonx_data_service.list_presto_engine_catalogs(
  engine_id='testString',
)
catalog_collection = response.get_result()

print(json.dumps(catalog_collection, indent=2))

Response

Response Body

CatalogCollection

GetCatalogs OK

CatalogCollection

GetCatalogs OK.

Examples:

View

CatalogCollection

GetCatalogs OK.

Examples:

View

CatalogCollection

GetCatalogs OK.

Examples:

View

CatalogCollection

GetCatalogs OK.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

{ "catalogs": [] }
{ "catalogs": [] }

Associate one or more catalogs to a presto engine

Associate one or more catalogs to a presto engine.

PUT /presto_engines/{engine_id}/catalogs

(watsonxData *WatsonxDataV2) ReplacePrestoEngineCatalogs(replacePrestoEngineCatalogsOptions *ReplacePrestoEngineCatalogsOptions) (result *CatalogCollection, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) ReplacePrestoEngineCatalogsWithContext(ctx context.Context, replacePrestoEngineCatalogsOptions *ReplacePrestoEngineCatalogsOptions) (result *CatalogCollection, response *core.DetailedResponse, err error)

ServiceCall<CatalogCollection> replacePrestoEngineCatalogs(ReplacePrestoEngineCatalogsOptions replacePrestoEngineCatalogsOptions)

replace_presto_engine_catalogs(
        self,
        engine_id: str,
        catalog_names: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

replacePrestoEngineCatalogs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.presto_engine_catalog.add

Request

Instantiate the ReplacePrestoEngineCatalogsOptions struct and set the fields to provide parameter values for the ReplacePrestoEngineCatalogs method.

Use the ReplacePrestoEngineCatalogsOptions.Builder to create a ReplacePrestoEngineCatalogsOptions object that contains the parameter values for the replacePrestoEngineCatalogs method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

Query Parameters

catalog_names
Required*
string
comma separated catalog names

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-_,]+$

parameter

WithContext method only

ReplacePrestoEngineCatalogsOptions

The ReplacePrestoEngineCatalogs options.

ReplacePrestoEngineCatalogsOptions

The replacePrestoEngineCatalogs options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalog_names
Required*
str
comma separated catalog names.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_,]+$/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalogNames
Required*
string
comma separated catalog names.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_,]+$/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'PUT' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/presto_engines/{engine_id}/catalogs?catalog_names=catalog_name1' -H 'accept: application/json' -H "AuthInstanceId: {instance id}"

Example request

const params = {
  engineId: 'testString',
  catalogNames: 'testString',
};

let res;
try {
  res = await watsonxDataService.replacePrestoEngineCatalogs(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

ReplacePrestoEngineCatalogsOptions replacePrestoEngineCatalogsOptions = new ReplacePrestoEngineCatalogsOptions.Builder()
  .engineId("testString")
  .catalogNames("testString")
  .build();

Response<CatalogCollection> response = watsonxDataService.replacePrestoEngineCatalogs(replacePrestoEngineCatalogsOptions).execute();
CatalogCollection catalogCollection = response.getResult();

System.out.println(catalogCollection);

Example request

response = watsonx_data_service.replace_presto_engine_catalogs(
  engine_id='testString',
  catalog_names='testString',
)
catalog_collection = response.get_result()

print(json.dumps(catalog_collection, indent=2))

Response

Response Body

CatalogCollection

GetCatalogs OK

CatalogCollection

GetCatalogs OK.

Examples:

View

CatalogCollection

GetCatalogs OK.

Examples:

View

CatalogCollection

GetCatalogs OK.

Examples:

View

CatalogCollection

GetCatalogs OK.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

{ "catalogs": [] }
{ "catalogs": [] }

Disassociate one or more catalogs from a presto engine

Disassociate one or more catalogs from a presto engine.

DELETE /presto_engines/{engine_id}/catalogs

(watsonxData *WatsonxDataV2) DeletePrestoEngineCatalogs(deletePrestoEngineCatalogsOptions *DeletePrestoEngineCatalogsOptions) (response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) DeletePrestoEngineCatalogsWithContext(ctx context.Context, deletePrestoEngineCatalogsOptions *DeletePrestoEngineCatalogsOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> deletePrestoEngineCatalogs(DeletePrestoEngineCatalogsOptions deletePrestoEngineCatalogsOptions)

delete_presto_engine_catalogs(
        self,
        engine_id: str,
        catalog_names: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

deletePrestoEngineCatalogs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.presto_engine_catalog.remove

Request

Instantiate the DeletePrestoEngineCatalogsOptions struct and set the fields to provide parameter values for the DeletePrestoEngineCatalogs method.

Use the DeletePrestoEngineCatalogsOptions.Builder to create a DeletePrestoEngineCatalogsOptions object that contains the parameter values for the deletePrestoEngineCatalogs method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

Query Parameters

catalog_names
Required*
string
Catalog id(s) to be stopped, comma separated

Possible values: 1 ≤ length ≤ 1000, Value must match regular expression ^[a-zA-Z0-9\-_,]+

parameter

WithContext method only

DeletePrestoEngineCatalogsOptions

The DeletePrestoEngineCatalogs options.

DeletePrestoEngineCatalogsOptions

The deletePrestoEngineCatalogs options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalog_names
Required*
str
Catalog id(s) to be stopped, comma separated.

Possible values: 1 ≤ length ≤ 1000, Value must match regular expression /^[a-zA-Z0-9\\-_,]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalogNames
Required*
string
Catalog id(s) to be stopped, comma separated.

Possible values: 1 ≤ length ≤ 1000, Value must match regular expression /^[a-zA-Z0-9\\-_,]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'DELETE' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/presto_engines/{engine_id}/catalogs?catalog_names=catalog_name1' -H 'accept: */*' -H "AuthInstanceId: {instance id}"

Example request

const params = {
  engineId: 'testString',
  catalogNames: 'testString',
};

try {
  await watsonxDataService.deletePrestoEngineCatalogs(params);
} catch (err) {
  console.warn(err);
}

Example request

DeletePrestoEngineCatalogsOptions deletePrestoEngineCatalogsOptions = new DeletePrestoEngineCatalogsOptions.Builder()
  .engineId("testString")
  .catalogNames("testString")
  .build();

Response<Void> response = watsonxDataService.deletePrestoEngineCatalogs(deletePrestoEngineCatalogsOptions).execute();

Example request

response = watsonx_data_service.delete_presto_engine_catalogs(
  engine_id='testString',
  catalog_names='testString',
)

Response

Status Code

204
No Content
400
Error
401
Unauthorized
404
Not found
500
Internal server error

No Sample Response

This method does not specify any sample responses.

Get catalog attached to presto engine

Get catalog attached to presto engine.

GET /presto_engines/{engine_id}/catalogs/{catalog_id}

(watsonxData *WatsonxDataV2) GetPrestoEngineCatalog(getPrestoEngineCatalogOptions *GetPrestoEngineCatalogOptions) (result *Catalog, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) GetPrestoEngineCatalogWithContext(ctx context.Context, getPrestoEngineCatalogOptions *GetPrestoEngineCatalogOptions) (result *Catalog, response *core.DetailedResponse, err error)

ServiceCall<Catalog> getPrestoEngineCatalog(GetPrestoEngineCatalogOptions getPrestoEngineCatalogOptions)

get_presto_engine_catalog(
        self,
        engine_id: str,
        catalog_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

getPrestoEngineCatalog(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.presto_engine_catalog.get

Request

Instantiate the GetPrestoEngineCatalogOptions struct and set the fields to provide parameter values for the GetPrestoEngineCatalog method.

Use the GetPrestoEngineCatalogOptions.Builder to create a GetPrestoEngineCatalogOptions object that contains the parameter values for the getPrestoEngineCatalog method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+
catalog_id
Required*
string
catalog id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-_]+

parameter

WithContext method only

GetPrestoEngineCatalogOptions

The GetPrestoEngineCatalog options.

GetPrestoEngineCatalogOptions

The getPrestoEngineCatalog options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalog_id
Required*
str
catalog id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalogId
Required*
string
catalog id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'GET' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/presto_engines/{engine_id}/catalogs/{catalog_id}' -H 'accept: application/json' -H "AuthInstanceId: {instance id}"

Example request

const params = {
  engineId: 'testString',
  catalogId: 'testString',
};

let res;
try {
  res = await watsonxDataService.getPrestoEngineCatalog(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

GetPrestoEngineCatalogOptions getPrestoEngineCatalogOptions = new GetPrestoEngineCatalogOptions.Builder()
  .engineId("testString")
  .catalogId("testString")
  .build();

Response<Catalog> response = watsonxDataService.getPrestoEngineCatalog(getPrestoEngineCatalogOptions).execute();
Catalog catalog = response.getResult();

System.out.println(catalog);

Example request

response = watsonx_data_service.get_presto_engine_catalog(
  engine_id='testString',
  catalog_id='testString',
)
catalog = response.get_result()

print(json.dumps(catalog, indent=2))

Response

Response Body

Catalog

Define the catalog details

Catalog

Define the catalog details.

Examples:

View

Catalog

Define the catalog details.

Examples:

View

Catalog

Define the catalog details.

Examples:

View

Catalog

Define the catalog details.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "actions": [
    "view",
    "update",
    "delete"
  ],
  "associated_buckets": [
    "ibm_cos_bucket"
  ],
  "associated_databases": [
    "iceberg_data"
  ],
  "associated_engines": [
    "presto367"
  ],
  "catalog_name": "iceberg_data",
  "catalog_type": "iceberg",
  "created_by": "user@domain.com",
  "created_on": "1700633239",
  "description": "catalog description",
  "hostname": "1234-xyz456-abc4321.lakehouse.dev.appdomain.cloud",
  "port": "31504",
  "sync_exception": [
    "table is corrupted",
    "table metadata not there"
  ],
  "tags": [
    "tag1",
    "tag2"
  ],
  "thrift_uri": "thrift://samplehost-catalog:4354"
}

Success example

{
  "actions": [
    "view",
    "update",
    "delete"
  ],
  "associated_buckets": [
    "ibm_cos_bucket"
  ],
  "associated_databases": [
    "iceberg_data"
  ],
  "associated_engines": [
    "presto367"
  ],
  "catalog_name": "iceberg_data",
  "catalog_type": "iceberg",
  "created_by": "user@domain.com",
  "created_on": "1700633239",
  "description": "catalog description",
  "hostname": "1234-xyz456-abc4321.lakehouse.dev.appdomain.cloud",
  "port": "31504",
  "sync_exception": [
    "table is corrupted",
    "table metadata not there"
  ],
  "tags": [
    "tag1",
    "tag2"
  ],
  "thrift_uri": "thrift://samplehost-catalog:4354"
}

Pause a running presto engine

Pause a running presto engine.

POST /presto_engines/{engine_id}/pause

(watsonxData *WatsonxDataV2) CreateEnginePause(createEnginePauseOptions *CreateEnginePauseOptions) (result *CreateEnginePauseCreatedBody, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) CreateEnginePauseWithContext(ctx context.Context, createEnginePauseOptions *CreateEnginePauseOptions) (result *CreateEnginePauseCreatedBody, response *core.DetailedResponse, err error)

ServiceCall<CreateEnginePauseCreatedBody> createEnginePause(CreateEnginePauseOptions createEnginePauseOptions)

create_engine_pause(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

createEnginePause(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.presto_engine.pause

Request

Instantiate the CreateEnginePauseOptions struct and set the fields to provide parameter values for the CreateEnginePause method.

Use the CreateEnginePauseOptions.Builder to create a CreateEnginePauseOptions object that contains the parameter values for the createEnginePause method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

CreateEnginePauseOptions

The CreateEnginePause options.

CreateEnginePauseOptions

The createEnginePause options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'POST' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/presto_engines/{engine_id}/pause' -H 'accept: application/json' -H "AuthInstanceId: {instance id}" -d ''

Example request

const params = {
  engineId: 'testString',
};

let res;
try {
  res = await watsonxDataService.createEnginePause(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

CreateEnginePauseOptions createEnginePauseOptions = new CreateEnginePauseOptions.Builder()
  .engineId("testString")
  .build();

Response<CreateEnginePauseCreatedBody> response = watsonxDataService.createEnginePause(createEnginePauseOptions).execute();
CreateEnginePauseCreatedBody createEnginePauseCreatedBody = response.getResult();

System.out.println(createEnginePauseCreatedBody);

Example request

response = watsonx_data_service.create_engine_pause(
  engine_id='testString',
)
create_engine_pause_created_body = response.get_result()

print(json.dumps(create_engine_pause_created_body, indent=2))

Response

Response Body

CreateEnginePauseCreatedBody

Pause

CreateEnginePauseCreatedBody

Pause.

Examples:

View

CreateEnginePauseCreatedBody

Pause.

Examples:

View

CreateEnginePauseCreatedBody

Pause.

Examples:

View

CreateEnginePauseCreatedBody

Pause.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "response": {
    "message": "pause presto engine",
    "message_code": "success"
  }
}

Success example

{
  "response": {
    "message": "pause presto engine",
    "message_code": "success"
  }
}

Explain a query statement

Explain a query statement.

POST /presto_engines/{engine_id}/query_explain

(watsonxData *WatsonxDataV2) RunExplainStatement(runExplainStatementOptions *RunExplainStatementOptions) (result *RunExplainStatementOKBody, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) RunExplainStatementWithContext(ctx context.Context, runExplainStatementOptions *RunExplainStatementOptions) (result *RunExplainStatementOKBody, response *core.DetailedResponse, err error)

ServiceCall<RunExplainStatementOKBody> runExplainStatement(RunExplainStatementOptions runExplainStatementOptions)

run_explain_statement(
        self,
        engine_id: str,
        statement: str,
        *,
        format: Optional[str] = None,
        type: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

runExplainStatement(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.query_explain.create

Request

Instantiate the RunExplainStatementOptions struct and set the fields to provide parameter values for the RunExplainStatement method.

Use the RunExplainStatementOptions.Builder to create a RunExplainStatementOptions object that contains the parameter values for the runExplainStatement method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
Engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

Request Body

Required*

ExplainPrototype

Request body

parameter

WithContext method only

RunExplainStatementOptions

The RunExplainStatement options.

RunExplainStatementOptions

The runExplainStatement options.

parameters

engine_id
Required*
str
Engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
statement
Required*
str
Presto query to determine explain plan.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
format
str
Format.

Allowable values: [,text,graphviz,json]
Possible values: 0 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
type
str
Type.

Allowable values: [,logical,distributed,validate,io]
Possible values: 0 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
Engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
statement
Required*
string
Presto query to determine explain plan.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
format
string
Format.

Allowable values: [,text,graphviz,json]
Possible values: 0 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
type
string
Type.

Allowable values: [,logical,distributed,validate,io]
Possible values: 0 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'POST' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/presto_engines/{engine_id}/query_explain' -H 'accept: application/json' -H 'Content-Type: application/json' -H "AuthInstanceId: {instance id}" -d '{  "format": "json",  "statement": "show schemas in catalog_name",  "type": "io"}'

Example request

const params = {
  engineId: 'testString',
  statement: 'show schemas in catalog_name',
};

let res;
try {
  res = await watsonxDataService.runExplainStatement(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

RunExplainStatementOptions runExplainStatementOptions = new RunExplainStatementOptions.Builder()
  .engineId("testString")
  .statement("show schemas in catalog_name")
  .build();

Response<RunExplainStatementOKBody> response = watsonxDataService.runExplainStatement(runExplainStatementOptions).execute();
RunExplainStatementOKBody runExplainStatementOkBody = response.getResult();

System.out.println(runExplainStatementOkBody);

Example request

response = watsonx_data_service.run_explain_statement(
  engine_id='testString',
  statement='show schemas in catalog_name',
)
run_explain_statement_ok_body = response.get_result()

print(json.dumps(run_explain_statement_ok_body, indent=2))

Response

Response Body

RunExplainStatementOKBody

ExplainStatement OK

RunExplainStatementOKBody

ExplainStatement OK.

Examples:

View

RunExplainStatementOKBody

ExplainStatement OK.

Examples:

View

RunExplainStatementOKBody

ExplainStatement OK.

Examples:

View

RunExplainStatementOKBody

ExplainStatement OK.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "response": {
    "message": "explain statement",
    "message_code": "success"
  },
  "result": "explain statement"
}

Success example

{
  "response": {
    "message": "explain statement",
    "message_code": "success"
  },
  "result": "explain statement"
}

Return query metrics after query is complete

Return query metrics after query is complete.

POST /presto_engines/{engine_id}/query_explain_analyze

(watsonxData *WatsonxDataV2) RunExplainAnalyzeStatement(runExplainAnalyzeStatementOptions *RunExplainAnalyzeStatementOptions) (result *RunExplainAnalyzeStatementOKBody, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) RunExplainAnalyzeStatementWithContext(ctx context.Context, runExplainAnalyzeStatementOptions *RunExplainAnalyzeStatementOptions) (result *RunExplainAnalyzeStatementOKBody, response *core.DetailedResponse, err error)

ServiceCall<RunExplainAnalyzeStatementOKBody> runExplainAnalyzeStatement(RunExplainAnalyzeStatementOptions runExplainAnalyzeStatementOptions)

run_explain_analyze_statement(
        self,
        engine_id: str,
        statement: str,
        *,
        verbose: Optional[bool] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

runExplainAnalyzeStatement(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.query_explain_analyze.create

Request

Instantiate the RunExplainAnalyzeStatementOptions struct and set the fields to provide parameter values for the RunExplainAnalyzeStatement method.

Use the RunExplainAnalyzeStatementOptions.Builder to create a RunExplainAnalyzeStatementOptions object that contains the parameter values for the runExplainAnalyzeStatement method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
Engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

Request Body

Required*

ExplainAnalyzePrototype

Request body

parameter

WithContext method only

RunExplainAnalyzeStatementOptions

The RunExplainAnalyzeStatement options.

RunExplainAnalyzeStatementOptions

The runExplainAnalyzeStatement options.

parameters

engine_id
Required*
str
Engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
statement
Required*
str
Presto query to show explain analyze.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
verbose
bool
Verbose.

Examples:
value
_source
_lines
_html
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
Engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
statement
Required*
string
Presto query to show explain analyze.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
verbose
boolean
Verbose.

Examples:
value
_source
_lines
_html
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'POST' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/presto_engines/{engine_id}/query_explain_analyze' -H 'accept: application/json' -H 'Content-Type: application/json' -H "AuthInstanceId: {instance id}" -d '{  "statement": "show schemas in catalog_name",  "verbose": true}'

Example request

const params = {
  engineId: 'testString',
  statement: 'show schemas in catalog_name',
};

let res;
try {
  res = await watsonxDataService.runExplainAnalyzeStatement(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

RunExplainAnalyzeStatementOptions runExplainAnalyzeStatementOptions = new RunExplainAnalyzeStatementOptions.Builder()
  .engineId("testString")
  .statement("show schemas in catalog_name")
  .build();

Response<RunExplainAnalyzeStatementOKBody> response = watsonxDataService.runExplainAnalyzeStatement(runExplainAnalyzeStatementOptions).execute();
RunExplainAnalyzeStatementOKBody runExplainAnalyzeStatementOkBody = response.getResult();

System.out.println(runExplainAnalyzeStatementOkBody);

Example request

response = watsonx_data_service.run_explain_analyze_statement(
  engine_id='testString',
  statement='show schemas in catalog_name',
)
run_explain_analyze_statement_ok_body = response.get_result()

print(json.dumps(run_explain_analyze_statement_ok_body, indent=2))

Response

Response Body

RunExplainAnalyzeStatementOKBody

explainAnalyzeStatement OK

RunExplainAnalyzeStatementOKBody

explainAnalyzeStatement OK.

Examples:

View

RunExplainAnalyzeStatementOKBody

explainAnalyzeStatement OK.

Examples:

View

RunExplainAnalyzeStatementOKBody

explainAnalyzeStatement OK.

Examples:

View

RunExplainAnalyzeStatementOKBody

explainAnalyzeStatement OK.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "response": {
    "message": "explain presto analyze",
    "message_code": "success"
  },
  "result": "explain statement"
}

Success example

{
  "response": {
    "message": "explain presto analyze",
    "message_code": "success"
  },
  "result": "explain statement"
}

Restart an existing presto engine

Restart an existing presto engine.

POST /presto_engines/{engine_id}/restart

(watsonxData *WatsonxDataV2) CreateEngineRestart(createEngineRestartOptions *CreateEngineRestartOptions) (result *CreateEngineRestartCreatedBody, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) CreateEngineRestartWithContext(ctx context.Context, createEngineRestartOptions *CreateEngineRestartOptions) (result *CreateEngineRestartCreatedBody, response *core.DetailedResponse, err error)

ServiceCall<CreateEngineRestartCreatedBody> createEngineRestart(CreateEngineRestartOptions createEngineRestartOptions)

create_engine_restart(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

createEngineRestart(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.presto_engine.refresh

Request

Instantiate the CreateEngineRestartOptions struct and set the fields to provide parameter values for the CreateEngineRestart method.

Use the CreateEngineRestartOptions.Builder to create a CreateEngineRestartOptions object that contains the parameter values for the createEngineRestart method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

CreateEngineRestartOptions

The CreateEngineRestart options.

CreateEngineRestartOptions

The createEngineRestart options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'POST' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/presto_engines/{engine_id}/restart' -H 'accept: application/json' -H "AuthInstanceId: {instance id}" -d ''

Example request

const params = {
  engineId: 'testString',
};

let res;
try {
  res = await watsonxDataService.createEngineRestart(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

CreateEngineRestartOptions createEngineRestartOptions = new CreateEngineRestartOptions.Builder()
  .engineId("testString")
  .build();

Response<CreateEngineRestartCreatedBody> response = watsonxDataService.createEngineRestart(createEngineRestartOptions).execute();
CreateEngineRestartCreatedBody createEngineRestartCreatedBody = response.getResult();

System.out.println(createEngineRestartCreatedBody);

Example request

response = watsonx_data_service.create_engine_restart(
  engine_id='testString',
)
create_engine_restart_created_body = response.get_result()

print(json.dumps(create_engine_restart_created_body, indent=2))

Response

Response Body

CreateEngineRestartCreatedBody

restart engine

CreateEngineRestartCreatedBody

restart engine.

Examples:

View

CreateEngineRestartCreatedBody

restart engine.

Examples:

View

CreateEngineRestartCreatedBody

restart engine.

Examples:

View

CreateEngineRestartCreatedBody

restart engine.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "response": {
    "message": "Restart presto engine",
    "message_code": "success"
  }
}

Success example

{
  "response": {
    "message": "Restart presto engine",
    "message_code": "success"
  }
}

Resume a paused presto engine

Resume a paused presto engine.

POST /presto_engines/{engine_id}/resume

(watsonxData *WatsonxDataV2) CreateEngineResume(createEngineResumeOptions *CreateEngineResumeOptions) (result *CreateEngineResumeCreatedBody, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) CreateEngineResumeWithContext(ctx context.Context, createEngineResumeOptions *CreateEngineResumeOptions) (result *CreateEngineResumeCreatedBody, response *core.DetailedResponse, err error)

ServiceCall<CreateEngineResumeCreatedBody> createEngineResume(CreateEngineResumeOptions createEngineResumeOptions)

create_engine_resume(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

createEngineResume(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.presto_engine.resume

Request

Instantiate the CreateEngineResumeOptions struct and set the fields to provide parameter values for the CreateEngineResume method.

Use the CreateEngineResumeOptions.Builder to create a CreateEngineResumeOptions object that contains the parameter values for the createEngineResume method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

CreateEngineResumeOptions

The CreateEngineResume options.

CreateEngineResumeOptions

The createEngineResume options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'POST' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/presto_engines/{engine_id}/resume' -H 'accept: application/json' -H "AuthInstanceId: {instance id}" -d ''

Example request

const params = {
  engineId: 'testString',
};

let res;
try {
  res = await watsonxDataService.createEngineResume(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

CreateEngineResumeOptions createEngineResumeOptions = new CreateEngineResumeOptions.Builder()
  .engineId("testString")
  .build();

Response<CreateEngineResumeCreatedBody> response = watsonxDataService.createEngineResume(createEngineResumeOptions).execute();
CreateEngineResumeCreatedBody createEngineResumeCreatedBody = response.getResult();

System.out.println(createEngineResumeCreatedBody);

Example request

response = watsonx_data_service.create_engine_resume(
  engine_id='testString',
)
create_engine_resume_created_body = response.get_result()

print(json.dumps(create_engine_resume_created_body, indent=2))

Response

Response Body

CreateEngineResumeCreatedBody

resume

CreateEngineResumeCreatedBody

resume.

Examples:

View

CreateEngineResumeCreatedBody

resume.

Examples:

View

CreateEngineResumeCreatedBody

resume.

Examples:

View

CreateEngineResumeCreatedBody

resume.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "response": {
    "message": "resume presto engine",
    "message_code": "success"
  }
}

Success example

{
  "response": {
    "message": "resume presto engine",
    "message_code": "success"
  }
}

Scale an existing presto engine

Scale an existing presto engine.

POST /presto_engines/{engine_id}/scale

(watsonxData *WatsonxDataV2) CreateEngineScale(createEngineScaleOptions *CreateEngineScaleOptions) (result *CreateEngineScaleCreatedBody, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) CreateEngineScaleWithContext(ctx context.Context, createEngineScaleOptions *CreateEngineScaleOptions) (result *CreateEngineScaleCreatedBody, response *core.DetailedResponse, err error)

ServiceCall<CreateEngineScaleCreatedBody> createEngineScale(CreateEngineScaleOptions createEngineScaleOptions)

create_engine_scale(
        self,
        engine_id: str,
        *,
        coordinator: Optional['NodeDescription'] = None,
        worker: Optional['NodeDescription'] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

createEngineScale(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.presto_engine.scale

Request

Instantiate the CreateEngineScaleOptions struct and set the fields to provide parameter values for the CreateEngineScale method.

Use the CreateEngineScaleOptions.Builder to create a CreateEngineScaleOptions object that contains the parameter values for the createEngineScale method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

Request Body

Required*

PrestoEngineScale

Scale Engine Body

parameter

WithContext method only

CreateEngineScaleOptions

The CreateEngineScale options.

CreateEngineScaleOptions

The createEngineScale options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
coordinator
NodeDescription.
worker
NodeDescription.
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
coordinator
NodeDescription.
worker
NodeDescription.
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'POST' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/presto_engines/{engine_id}/scale' -H 'accept: application/json' -H 'Content-Type: application/json' -H "AuthInstanceId: {instance id}" -d '{  "coordinator": {    "node_type": "worker",    "quantity": 0  },  "worker": {    "node_type": "worker",    "quantity": 0  }}'

Example request

const params = {
  engineId: 'testString',
};

let res;
try {
  res = await watsonxDataService.createEngineScale(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

CreateEngineScaleOptions createEngineScaleOptions = new CreateEngineScaleOptions.Builder()
  .engineId("testString")
  .build();

Response<CreateEngineScaleCreatedBody> response = watsonxDataService.createEngineScale(createEngineScaleOptions).execute();
CreateEngineScaleCreatedBody createEngineScaleCreatedBody = response.getResult();

System.out.println(createEngineScaleCreatedBody);

Example request

response = watsonx_data_service.create_engine_scale(
  engine_id='testString',
)
create_engine_scale_created_body = response.get_result()

print(json.dumps(create_engine_scale_created_body, indent=2))

Response

Response Body

CreateEngineScaleCreatedBody

scale engine

CreateEngineScaleCreatedBody

scale engine.

Examples:

View

CreateEngineScaleCreatedBody

scale engine.

Examples:

View

CreateEngineScaleCreatedBody

scale engine.

Examples:

View

CreateEngineScaleCreatedBody

scale engine.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "response": {
    "message": "scale presto engine",
    "message_code": "success"
  }
}

Success example

{
  "response": {
    "message": "scale presto engine",
    "message_code": "success"
  }
}

List all spark engines

List all spark engines.

GET /spark_engines

(watsonxData *WatsonxDataV2) ListSparkEngines(listSparkEnginesOptions *ListSparkEnginesOptions) (result *SparkEngineCollection, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) ListSparkEnginesWithContext(ctx context.Context, listSparkEnginesOptions *ListSparkEnginesOptions) (result *SparkEngineCollection, response *core.DetailedResponse, err error)

ServiceCall<SparkEngineCollection> listSparkEngines(ListSparkEnginesOptions listSparkEnginesOptions)

list_spark_engines(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

listSparkEngines(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.spark_engine.get

Request

Instantiate the ListSparkEnginesOptions struct and set the fields to provide parameter values for the ListSparkEngines method.

Use the ListSparkEnginesOptions.Builder to create a ListSparkEnginesOptions object that contains the parameter values for the listSparkEngines method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

parameter

WithContext method only

ListSparkEnginesOptions

The ListSparkEngines options.

ListSparkEnginesOptions

The listSparkEngines options.

parameters

auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X GET -H "content-type: application/json" -H "AuthInstanceId: {instance_id}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/spark_engine"

Example request

let res;
try {
  res = await watsonxDataService.listSparkEngines({});
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

ListSparkEnginesOptions listSparkEnginesOptions = new ListSparkEnginesOptions.Builder()
  .build();

Response<SparkEngineCollection> response = watsonxDataService.listSparkEngines(listSparkEnginesOptions).execute();
SparkEngineCollection sparkEngineCollection = response.getResult();

System.out.println(sparkEngineCollection);

Example request

response = watsonx_data_service.list_spark_engines()
spark_engine_collection = response.get_result()

print(json.dumps(spark_engine_collection, indent=2))

Response

Response Body

SparkEngineCollection

List spark engines

SparkEngineCollection

List spark engines.

Examples:

View

SparkEngineCollection

List spark engines.

Examples:

View

SparkEngineCollection

List spark engines.

Examples:

View

SparkEngineCollection

List spark engines.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "spark_engines": [
    {
      "actions": [
        "update",
        "delete"
      ],
      "created_by": "<username>@<domain>.com",
      "created_on": 163788384993,
      "description": "Spark engines for running spark applications",
      "engine_details": {
        "connection_string": "https://xyz.<region>.ae.cloud.123.com/v3/analytics_engines/<spark_iae_id>",
        "endpoints": {
          "applications_api": "$HOST/v4/analytics_engines/<spark_id>/spark_applications/<application_id>",
          "history_server_endpoint": "$HOST/v2/spark/v3/instances/<spark_id>/spark_history_server",
          "spark_access_endpoint": "$HOST/analytics-engine/details/spark-<instance_id>",
          "spark_jobs_v4_endpoint": "$HOST/v4/analytics_engines/<spark_id>/spark_applications",
          "spark_kernel_endpoint": "$HOST/v4/analytics_engines/<spark_id>/jkg/api/kernels",
          "view_history_server": "View history server",
          "wxd_application_endpoint": "$HOST/v1/<wxd_instance_id>/engines/<engine_id>/applications"
        }
      },
      "engine_display_name": "sampleEngine",
      "engine_id": "sampleEngine123",
      "origin": "discover",
      "status": "REGISTERED",
      "tags": [
        "tag1",
        "tag2"
      ],
      "type": "spark"
    }
  ]
}

Success example

{
  "spark_engines": [
    {
      "actions": [
        "update",
        "delete"
      ],
      "created_by": "<username>@<domain>.com",
      "created_on": 163788384993,
      "description": "Spark engines for running spark applications",
      "engine_details": {
        "connection_string": "https://xyz.<region>.ae.cloud.123.com/v3/analytics_engines/<spark_iae_id>",
        "endpoints": {
          "applications_api": "$HOST/v4/analytics_engines/<spark_id>/spark_applications/<application_id>",
          "history_server_endpoint": "$HOST/v2/spark/v3/instances/<spark_id>/spark_history_server",
          "spark_access_endpoint": "$HOST/analytics-engine/details/spark-<instance_id>",
          "spark_jobs_v4_endpoint": "$HOST/v4/analytics_engines/<spark_id>/spark_applications",
          "spark_kernel_endpoint": "$HOST/v4/analytics_engines/<spark_id>/jkg/api/kernels",
          "view_history_server": "View history server",
          "wxd_application_endpoint": "$HOST/v1/<wxd_instance_id>/engines/<engine_id>/applications"
        }
      },
      "engine_display_name": "sampleEngine",
      "engine_id": "sampleEngine123",
      "origin": "discover",
      "status": "REGISTERED",
      "tags": [
        "tag1",
        "tag2"
      ],
      "type": "spark"
    }
  ]
}

Create a new spark engine

Create a new spark engine.

POST /spark_engines

(watsonxData *WatsonxDataV2) CreateSparkEngine(createSparkEngineOptions *CreateSparkEngineOptions) (result *SparkEngine, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) CreateSparkEngineWithContext(ctx context.Context, createSparkEngineOptions *CreateSparkEngineOptions) (result *SparkEngine, response *core.DetailedResponse, err error)

ServiceCall<SparkEngine> createSparkEngine(CreateSparkEngineOptions createSparkEngineOptions)

create_spark_engine(
        self,
        origin: str,
        type: str,
        *,
        description: Optional[str] = None,
        engine_details: Optional['SparkEngineDetailsPrototype'] = None,
        engine_display_name: Optional[str] = None,
        tags: Optional[List[str]] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

createSparkEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.spark_engine.create

Request

Instantiate the CreateSparkEngineOptions struct and set the fields to provide parameter values for the CreateSparkEngine method.

Use the CreateSparkEngineOptions.Builder to create a CreateSparkEngineOptions object that contains the parameter values for the createSparkEngine method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Request Body

Required*

SparkEnginePrototype

Create spark engine Body

parameter

WithContext method only

CreateSparkEngineOptions

The CreateSparkEngine options.

CreateSparkEngineOptions

The createSparkEngine options.

parameters

origin
Required*
str
Origin - created or registered.

Allowable values: [external,discover]
Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
type
Required*
str
Engine type spark, others like netezza.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
description
str
Engine description.

Possible values: 0 ≤ length ≤ 1024, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
engine_details
Node details.
engine_display_name
str
Engine display name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
tags
List[str]
Tags.

Possible values: 0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

origin
Required*
string
Origin - created or registered.

Allowable values: [external,discover]
Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
type
Required*
string
Engine type spark, others like netezza.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
description
string
Engine description.

Possible values: 0 ≤ length ≤ 1024, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
engineDetails
Node details.
engineDisplayName
string
Engine display name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
tags
string[]
Tags.

Possible values: 0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X POST -H "content-type: application/json" -H "accept: application/json" -H "AuthInstanceId: {instance_id}" -d '{ "description": "spark engine description", "engine_details": { "api_key": "apikey", "connection_string": "1.2.3.4", "instance_id": "spark-id", "managed_by": "fully/self" }, "engine_display_name": "sampleEngine", "origin": "discover/external", "tags": [ "tag1", "tag2" ], "type": "spark" }' "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/spark_engines"

Example request

const params = {
  origin: 'external',
  type: 'spark',
};

let res;
try {
  res = await watsonxDataService.createSparkEngine(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

CreateSparkEngineOptions createSparkEngineOptions = new CreateSparkEngineOptions.Builder()
  .origin("external")
  .type("spark")
  .build();

Response<SparkEngine> response = watsonxDataService.createSparkEngine(createSparkEngineOptions).execute();
SparkEngine sparkEngine = response.getResult();

System.out.println(sparkEngine);

Example request

response = watsonx_data_service.create_spark_engine(
  origin='external',
  type='spark',
)
spark_engine = response.get_result()

print(json.dumps(spark_engine, indent=2))

Response

Response Body

SparkEngine

EngineDetail

SparkEngine

EngineDetail.

Examples:

View

SparkEngine

EngineDetail.

Examples:

View

SparkEngine

EngineDetail.

Examples:

View

SparkEngine

EngineDetail.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "SparkEngine": {
    "actions": [
      "update",
      "delete"
    ],
    "created_by": "<username>@<domain>.com",
    "created_on": 163788384993,
    "description": "Spark engines for running spark applications",
    "engine_details": {
      "connection_string": "https://xyz.<region>.ae.cloud.123.com/v3/analytics_engines/<spark_iae_id>",
      "endpoints": {
        "applications_api": "$HOST/v4/analytics_engines/<spark_id>/spark_applications/<application_id>",
        "history_server_endpoint": "$HOST/v2/spark/v3/instances/<spark_id>/spark_history_server",
        "spark_access_endpoint": "$HOST/analytics-engine/details/spark-<instance_id>",
        "spark_jobs_v4_endpoint": "$HOST/v4/analytics_engines/<spark_id>/spark_applications",
        "spark_kernel_endpoint": "$HOST/v4/analytics_engines/<spark_id>/jkg/api/kernels",
        "view_history_server": "View history server",
        "wxd_application_endpoint": "$HOST/v1/<wxd_instance_id>/engines/<engine_id>/applications"
      }
    },
    "engine_display_name": "sampleEngine",
    "engine_id": "sampleEngine123",
    "origin": "discover",
    "status": "REGISTERED",
    "tags": [
      "tag1",
      "tag2"
    ],
    "type": "spark"
  }
}

Success example

{
  "SparkEngine": {
    "actions": [
      "update",
      "delete"
    ],
    "created_by": "<username>@<domain>.com",
    "created_on": 163788384993,
    "description": "Spark engines for running spark applications",
    "engine_details": {
      "connection_string": "https://xyz.<region>.ae.cloud.123.com/v3/analytics_engines/<spark_iae_id>",
      "endpoints": {
        "applications_api": "$HOST/v4/analytics_engines/<spark_id>/spark_applications/<application_id>",
        "history_server_endpoint": "$HOST/v2/spark/v3/instances/<spark_id>/spark_history_server",
        "spark_access_endpoint": "$HOST/analytics-engine/details/spark-<instance_id>",
        "spark_jobs_v4_endpoint": "$HOST/v4/analytics_engines/<spark_id>/spark_applications",
        "spark_kernel_endpoint": "$HOST/v4/analytics_engines/<spark_id>/jkg/api/kernels",
        "view_history_server": "View history server",
        "wxd_application_endpoint": "$HOST/v1/<wxd_instance_id>/engines/<engine_id>/applications"
      }
    },
    "engine_display_name": "sampleEngine",
    "engine_id": "sampleEngine123",
    "origin": "discover",
    "status": "REGISTERED",
    "tags": [
      "tag1",
      "tag2"
    ],
    "type": "spark"
  }
}

Delete a spark engine

Delete a spark engine.

DELETE /spark_engines/{engine_id}

(watsonxData *WatsonxDataV2) DeleteSparkEngine(deleteSparkEngineOptions *DeleteSparkEngineOptions) (response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) DeleteSparkEngineWithContext(ctx context.Context, deleteSparkEngineOptions *DeleteSparkEngineOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> deleteSparkEngine(DeleteSparkEngineOptions deleteSparkEngineOptions)

delete_spark_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

deleteSparkEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.spark_engine.delete

Request

Instantiate the DeleteSparkEngineOptions struct and set the fields to provide parameter values for the DeleteSparkEngine method.

Use the DeleteSparkEngineOptions.Builder to create a DeleteSparkEngineOptions object that contains the parameter values for the deleteSparkEngine method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

DeleteSparkEngineOptions

The DeleteSparkEngine options.

DeleteSparkEngineOptions

The deleteSparkEngine options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X DELETE -H "accept: */*" -H "AuthInstanceId: {instance_id}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/spark_engines/{engine_id}"

Example request

const params = {
  engineId: 'testString',
};

try {
  await watsonxDataService.deleteSparkEngine(params);
} catch (err) {
  console.warn(err);
}

Example request

DeleteSparkEngineOptions deleteSparkEngineOptions = new DeleteSparkEngineOptions.Builder()
  .engineId("testString")
  .build();

Response<Void> response = watsonxDataService.deleteSparkEngine(deleteSparkEngineOptions).execute();

Example request

response = watsonx_data_service.delete_spark_engine(
  engine_id='testString',
)

Response

Status Code

204
No Content
400
Error
401
Unauthorized
404
Not found
500
Internal server error

No Sample Response

This method does not specify any sample responses.

Update details of spark engine

Update details of spark engine.

PATCH /spark_engines/{engine_id}

(watsonxData *WatsonxDataV2) UpdateSparkEngine(updateSparkEngineOptions *UpdateSparkEngineOptions) (result *SparkEngine, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) UpdateSparkEngineWithContext(ctx context.Context, updateSparkEngineOptions *UpdateSparkEngineOptions) (result *SparkEngine, response *core.DetailedResponse, err error)

ServiceCall<SparkEngine> updateSparkEngine(UpdateSparkEngineOptions updateSparkEngineOptions)

update_spark_engine(
        self,
        engine_id: str,
        body: List['JsonPatchOperation'],
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

updateSparkEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.spark_engine.update

Request

Instantiate the UpdateSparkEngineOptions struct and set the fields to provide parameter values for the UpdateSparkEngine method.

Use the UpdateSparkEngineOptions.Builder to create a UpdateSparkEngineOptions object that contains the parameter values for the updateSparkEngine method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

Request Body

Required*

application/json-patch+jsonUpdateSparkEngineBody

Update Engine Body

parameter

WithContext method only

UpdateSparkEngineOptions

The UpdateSparkEngine options.

UpdateSparkEngineOptions

The updateSparkEngine options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
body
Required*
List[JsonPatchOperation]
Update Engine Body.
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
body
Required*
JsonPatchOperation[]
Update Engine Body.
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X PATCH -H "content-type: application/json" -H "accept: application/json" -H "AuthInstanceId: {instance_id}" -d '{ "description": "updated description for spark engine", "engine_display_name": "sampleEngine", "tags": [ "tag1", "tag2" ] }' "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/spark_engines/{engine_id}"

Example request

// Request models needed by this operation.

// JsonPatchOperation
const jsonPatchOperationModel = {
  op: 'add',
  path: 'testString',
};

const params = {
  engineId: 'testString',
  body: [jsonPatchOperationModel],
};

let res;
try {
  res = await watsonxDataService.updateSparkEngine(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

JsonPatchOperation jsonPatchOperationModel = new JsonPatchOperation.Builder()
  .op("add")
  .path("testString")
  .build();
UpdateSparkEngineOptions updateSparkEngineOptions = new UpdateSparkEngineOptions.Builder()
  .engineId("testString")
  .body(java.util.Arrays.asList(jsonPatchOperationModel))
  .build();

Response<SparkEngine> response = watsonxDataService.updateSparkEngine(updateSparkEngineOptions).execute();
SparkEngine sparkEngine = response.getResult();

System.out.println(sparkEngine);

Example request

json_patch_operation_model = {
  'op': 'add',
  'path': 'testString',
}

response = watsonx_data_service.update_spark_engine(
  engine_id='testString',
  body=[json_patch_operation_model],
)
spark_engine = response.get_result()

print(json.dumps(spark_engine, indent=2))

Response

Response Body

SparkEngine

EngineDetail

SparkEngine

EngineDetail.

Examples:

View

SparkEngine

EngineDetail.

Examples:

View

SparkEngine

EngineDetail.

Examples:

View

SparkEngine

EngineDetail.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "SparkEngine": {
    "actions": [
      "update",
      "delete"
    ],
    "created_by": "<username>@<domain>.com",
    "created_on": 163788384993,
    "description": "Spark engines for running spark applications",
    "engine_details": {
      "connection_string": "https://xyz.<region>.ae.cloud.123.com/v3/analytics_engines/<spark_iae_id>",
      "endpoints": {
        "applications_api": "$HOST/v4/analytics_engines/<spark_id>/spark_applications/<application_id>",
        "history_server_endpoint": "$HOST/v2/spark/v3/instances/<spark_id>/spark_history_server",
        "spark_access_endpoint": "$HOST/analytics-engine/details/spark-<instance_id>",
        "spark_jobs_v4_endpoint": "$HOST/v4/analytics_engines/<spark_id>/spark_applications",
        "spark_kernel_endpoint": "$HOST/v4/analytics_engines/<spark_id>/jkg/api/kernels",
        "view_history_server": "View history server",
        "wxd_application_endpoint": "$HOST/v1/<wxd_instance_id>/engines/<engine_id>/applications"
      }
    },
    "engine_display_name": "sampleEngine",
    "engine_id": "sampleEngine123",
    "origin": "discover",
    "status": "REGISTERED",
    "tags": [
      "tag1",
      "tag2"
    ],
    "type": "spark"
  }
}

Success example

{
  "SparkEngine": {
    "actions": [
      "update",
      "delete"
    ],
    "created_by": "<username>@<domain>.com",
    "created_on": 163788384993,
    "description": "Spark engines for running spark applications",
    "engine_details": {
      "connection_string": "https://xyz.<region>.ae.cloud.123.com/v3/analytics_engines/<spark_iae_id>",
      "endpoints": {
        "applications_api": "$HOST/v4/analytics_engines/<spark_id>/spark_applications/<application_id>",
        "history_server_endpoint": "$HOST/v2/spark/v3/instances/<spark_id>/spark_history_server",
        "spark_access_endpoint": "$HOST/analytics-engine/details/spark-<instance_id>",
        "spark_jobs_v4_endpoint": "$HOST/v4/analytics_engines/<spark_id>/spark_applications",
        "spark_kernel_endpoint": "$HOST/v4/analytics_engines/<spark_id>/jkg/api/kernels",
        "view_history_server": "View history server",
        "wxd_application_endpoint": "$HOST/v1/<wxd_instance_id>/engines/<engine_id>/applications"
      }
    },
    "engine_display_name": "sampleEngine",
    "engine_id": "sampleEngine123",
    "origin": "discover",
    "status": "REGISTERED",
    "tags": [
      "tag1",
      "tag2"
    ],
    "type": "spark"
  }
}

List all applications in a spark engine

List all applications in a spark engine.

GET /spark_engines/{engine_id}/applications

(watsonxData *WatsonxDataV2) ListSparkEngineApplications(listSparkEngineApplicationsOptions *ListSparkEngineApplicationsOptions) (result *SparkEngineApplicationStatusCollection, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) ListSparkEngineApplicationsWithContext(ctx context.Context, listSparkEngineApplicationsOptions *ListSparkEngineApplicationsOptions) (result *SparkEngineApplicationStatusCollection, response *core.DetailedResponse, err error)

ServiceCall<SparkEngineApplicationStatusCollection> listSparkEngineApplications(ListSparkEngineApplicationsOptions listSparkEngineApplicationsOptions)

list_spark_engine_applications(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

listSparkEngineApplications(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.spark_engine_application.list

Request

Instantiate the ListSparkEngineApplicationsOptions struct and set the fields to provide parameter values for the ListSparkEngineApplications method.

Use the ListSparkEngineApplicationsOptions.Builder to create a ListSparkEngineApplicationsOptions object that contains the parameter values for the listSparkEngineApplications method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

ListSparkEngineApplicationsOptions

The ListSparkEngineApplications options.

ListSparkEngineApplicationsOptions

The listSparkEngineApplications options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X GET -H "content-type: application/json" -H "AuthInstanceId: {instance_id}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/spark_engines/{engine_id}/applications"

Example request

const params = {
  engineId: 'testString',
};

let res;
try {
  res = await watsonxDataService.listSparkEngineApplications(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

ListSparkEngineApplicationsOptions listSparkEngineApplicationsOptions = new ListSparkEngineApplicationsOptions.Builder()
  .engineId("testString")
  .build();

Response<SparkEngineApplicationStatusCollection> response = watsonxDataService.listSparkEngineApplications(listSparkEngineApplicationsOptions).execute();
SparkEngineApplicationStatusCollection sparkEngineApplicationStatusCollection = response.getResult();

System.out.println(sparkEngineApplicationStatusCollection);

Example request

response = watsonx_data_service.list_spark_engine_applications(
  engine_id='testString',
)
spark_engine_application_status_collection = response.get_result()

print(json.dumps(spark_engine_application_status_collection, indent=2))

Response

Response Body

SparkEngineApplicationStatusCollection

Engine Application Detail

SparkEngineApplicationStatusCollection

Engine Application Detail.

Examples:

View

SparkEngineApplicationStatusCollection

Engine Application Detail.

Examples:

View

SparkEngineApplicationStatusCollection

Engine Application Detail.

Examples:

View

SparkEngineApplicationStatusCollection

Engine Application Detail.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "applications": [
    {
      "application_id": "<application_id>",
      "auto_termination_time": "2020-12-08T10:00:00.000Z",
      "creation_time": "2020-12-08T10:00:00.000Z",
      "end_time": "2020-12-08T10:00:00.000Z",
      "failed_time": "2020-12-08T10:00:00.000Z",
      "finish_time": "2020-12-08T10:00:00.000Z",
      "runtime": {
        "spark_version": "3.3"
      },
      "spark_application_id": "spark-application-16073847388_0001",
      "spark_application_name": "sample-application-name",
      "start_time": "2020-12-08T10:00:00.000Z",
      "state": "running",
      "submission_time": "2023-11-01T11:18:49.758Z",
      "template_id": "spark-3.3-jaas-v2-cp4d-template"
    }
  ]
}

Success example

{
  "applications": [
    {
      "application_id": "<application_id>",
      "auto_termination_time": "2020-12-08T10:00:00.000Z",
      "creation_time": "2020-12-08T10:00:00.000Z",
      "end_time": "2020-12-08T10:00:00.000Z",
      "failed_time": "2020-12-08T10:00:00.000Z",
      "finish_time": "2020-12-08T10:00:00.000Z",
      "runtime": {
        "spark_version": "3.3"
      },
      "spark_application_id": "spark-application-16073847388_0001",
      "spark_application_name": "sample-application-name",
      "start_time": "2020-12-08T10:00:00.000Z",
      "state": "running",
      "submission_time": "2023-11-01T11:18:49.758Z",
      "template_id": "spark-3.3-jaas-v2-cp4d-template"
    }
  ]
}

Submit engine applications

Submit engine applications.

POST /spark_engines/{engine_id}/applications

(watsonxData *WatsonxDataV2) CreateSparkEngineApplication(createSparkEngineApplicationOptions *CreateSparkEngineApplicationOptions) (result *SparkEngineApplicationStatus, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) CreateSparkEngineApplicationWithContext(ctx context.Context, createSparkEngineApplicationOptions *CreateSparkEngineApplicationOptions) (result *SparkEngineApplicationStatus, response *core.DetailedResponse, err error)

ServiceCall<SparkEngineApplicationStatus> createSparkEngineApplication(CreateSparkEngineApplicationOptions createSparkEngineApplicationOptions)

create_spark_engine_application(
        self,
        engine_id: str,
        application_details: 'SparkApplicationDetails',
        *,
        job_endpoint: Optional[str] = None,
        service_instance_id: Optional[str] = None,
        type: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

createSparkEngineApplication(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.spark_engine_application.create

Request

Instantiate the CreateSparkEngineApplicationOptions struct and set the fields to provide parameter values for the CreateSparkEngineApplication method.

Use the CreateSparkEngineApplicationOptions.Builder to create a CreateSparkEngineApplicationOptions object that contains the parameter values for the createSparkEngineApplication method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

Request Body

Required*

SparkEngineApplicationStatusPrototype

Create spark application parameters

parameter

WithContext method only

CreateSparkEngineApplicationOptions

The CreateSparkEngineApplication options.

CreateSparkEngineApplicationOptions

The createSparkEngineApplication options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
application_details
Application details.
job_endpoint
str
Job endpoint.

Possible values: 1 ≤ length ≤ 1000, Value must match regular expression /^.+$/
Examples:
value
_source
_lines
_html
service_instance_id
str
Service Instance ID for POST.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
type
str
Engine Type.

Allowable values: [iae,emr]
Examples:
value
_source
_lines
_html
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
applicationDetails
Application details.
jobEndpoint
string
Job endpoint.

Possible values: 1 ≤ length ≤ 1000, Value must match regular expression /^.+$/
Examples:
value
_source
_lines
_html
serviceInstanceId
string
Service Instance ID for POST.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+$/
type
string
Engine Type.

Allowable values: [iae,emr]
Examples:
value
_source
_lines
_html
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X POST -H "content-type: application/json" -H "accept: application/json" -H "AuthInstanceId: {instance_id}" -d '{ "application_details": { "application": "s3://mybucket/wordcount.py", "arguments": [ "people.txt" ], "conf": { "additionalProp1": "key:value", "additionalProp2": "key:value", "additionalProp3": "key:value" }, "env": { "additionalProp1": "key:value", "additionalProp2": "key:value", "additionalProp3": "key:value" }, "name": "SparkApplicaton1" }, "job_endpoint": "<host>/v4/analytics_engines/c7b3fccf-badb-46b0-b1ef-9b3154424021/engine_applications", "service_instance_id": "3FGeNUZqcdu6rOFbaHhGBoNdCHj98UoHd6nUFqkfsKhgacYD8ImM6iSA_F-TjHUdEZuVsoQTmOn", "type": "iae" }' "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/spark_engines/{engine_id}/applications"

Example request

// Request models needed by this operation.

// SparkApplicationDetailsConf
const sparkApplicationDetailsConfModel = {
};

// SparkApplicationDetails
const sparkApplicationDetailsModel = {
  application: 's3://mybucket/wordcount.py',
  arguments: ['people.txt'],
  conf: sparkApplicationDetailsConfModel,
  env: { anyKey: 'anyValue' },
};

const params = {
  engineId: 'testString',
  applicationDetails: sparkApplicationDetailsModel,
};

let res;
try {
  res = await watsonxDataService.createSparkEngineApplication(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

SparkApplicationDetailsConf sparkApplicationDetailsConfModel = new SparkApplicationDetailsConf.Builder()
  .build();
SparkApplicationDetails sparkApplicationDetailsModel = new SparkApplicationDetails.Builder()
  .application("s3://mybucket/wordcount.py")
  .arguments(java.util.Arrays.asList("people.txt"))
  .conf(sparkApplicationDetailsConfModel)
  .env(new java.util.HashMap<String, Object>())
  .build();
CreateSparkEngineApplicationOptions createSparkEngineApplicationOptions = new CreateSparkEngineApplicationOptions.Builder()
  .engineId("testString")
  .applicationDetails(sparkApplicationDetailsModel)
  .build();

Response<SparkEngineApplicationStatus> response = watsonxDataService.createSparkEngineApplication(createSparkEngineApplicationOptions).execute();
SparkEngineApplicationStatus sparkEngineApplicationStatus = response.getResult();

System.out.println(sparkEngineApplicationStatus);

Example request

spark_application_details_conf_model = {
}

spark_application_details_model = {
  'application': 's3://mybucket/wordcount.py',
  'arguments': ['people.txt'],
  'conf': spark_application_details_conf_model,
  'env': {'anyKey': 'anyValue'},
}

response = watsonx_data_service.create_spark_engine_application(
  engine_id='testString',
  application_details=spark_application_details_model,
)
spark_engine_application_status = response.get_result()

print(json.dumps(spark_engine_application_status, indent=2))

Response

Response Body

SparkEngineApplicationStatus

Engine Application Status

SparkEngineApplicationStatus

Engine Application Status.

Examples:

View

SparkEngineApplicationStatus

Engine Application Status.

Examples:

View

SparkEngineApplicationStatus

Engine Application Status.

Examples:

View

SparkEngineApplicationStatus

Engine Application Status.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "application": {
    "application_details": {
      "application": "/opt/xyz/spark/examples/src/main/python/wordcount.py",
      "arguments": [
        "/opt/xyz/spark/examples/src/main/python/people.txt"
      ],
      "conf": {
        "sparkConfPropKey1": "sparkConfPropvalue1",
        "sparkConfPropKey2": "sparkConfPropvalue2"
      },
      "env": {
        "sparkEnvPropKey1": "sparkEnvPropvalue1",
        "sparkEnvPropKey2": "sparkEnvPropvalue2"
      },
      "name": "SparkApplication1"
    },
    "application_id": "<application_id>",
    "auto_termination_time": "2023-11-04T15:37:57.775Z",
    "end_time": "2023-11-01T15:38:07.188Z",
    "id": "id-ca61-454c-aab3-486d39d8c1d0",
    "return_code": "1",
    "spark_application_id": "<spark_application_id>",
    "spark_application_name": "PythonWordCount",
    "start_time": "2023-11-01T15:37:57.775Z",
    "state": "failed",
    "state_details\"": [
      {
        "code": "server_error",
        "message": "A server error occurred while submitting or running your application.",
        "type": "server_error"
      }
    ],
    "submission_time": "2023-11-01T15:37:30.982Z"
  }
}

Success example

{
  "application": {
    "application_details": {
      "application": "/opt/xyz/spark/examples/src/main/python/wordcount.py",
      "arguments": [
        "/opt/xyz/spark/examples/src/main/python/people.txt"
      ],
      "conf": {
        "sparkConfPropKey1": "sparkConfPropvalue1",
        "sparkConfPropKey2": "sparkConfPropvalue2"
      },
      "env": {
        "sparkEnvPropKey1": "sparkEnvPropvalue1",
        "sparkEnvPropKey2": "sparkEnvPropvalue2"
      },
      "name": "SparkApplication1"
    },
    "application_id": "<application_id>",
    "auto_termination_time": "2023-11-04T15:37:57.775Z",
    "end_time": "2023-11-01T15:38:07.188Z",
    "id": "id-ca61-454c-aab3-486d39d8c1d0",
    "return_code": "1",
    "spark_application_id": "<spark_application_id>",
    "spark_application_name": "PythonWordCount",
    "start_time": "2023-11-01T15:37:57.775Z",
    "state": "failed",
    "state_details\"": [
      {
        "code": "server_error",
        "message": "A server error occurred while submitting or running your application.",
        "type": "server_error"
      }
    ],
    "submission_time": "2023-11-01T15:37:30.982Z"
  }
}

Stop a running spark application

Stop a running spark application.

DELETE /spark_engines/{engine_id}/applications

(watsonxData *WatsonxDataV2) DeleteSparkEngineApplications(deleteSparkEngineApplicationsOptions *DeleteSparkEngineApplicationsOptions) (response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) DeleteSparkEngineApplicationsWithContext(ctx context.Context, deleteSparkEngineApplicationsOptions *DeleteSparkEngineApplicationsOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> deleteSparkEngineApplications(DeleteSparkEngineApplicationsOptions deleteSparkEngineApplicationsOptions)

delete_spark_engine_applications(
        self,
        engine_id: str,
        application_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

deleteSparkEngineApplications(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.spark_engine_application.delete

Request

Instantiate the DeleteSparkEngineApplicationsOptions struct and set the fields to provide parameter values for the DeleteSparkEngineApplications method.

Use the DeleteSparkEngineApplicationsOptions.Builder to create a DeleteSparkEngineApplicationsOptions object that contains the parameter values for the deleteSparkEngineApplications method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

Query Parameters

application_id
Required*
string
Application id(s) to be stopped, comma separated

Possible values: 1 ≤ length ≤ 1000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

DeleteSparkEngineApplicationsOptions

The DeleteSparkEngineApplications options.

DeleteSparkEngineApplicationsOptions

The deleteSparkEngineApplications options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
application_id
Required*
str
Application id(s) to be stopped, comma separated.

Possible values: 1 ≤ length ≤ 1000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
applicationId
Required*
string
Application id(s) to be stopped, comma separated.

Possible values: 1 ≤ length ≤ 1000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X DELETE -H "accept: */*" -H "AuthInstanceId: {instance_id}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/spark_engines/{engine_id}/applications?application_id={application_id}"

Example request

const params = {
  engineId: 'testString',
  applicationId: 'testString',
};

try {
  await watsonxDataService.deleteSparkEngineApplications(params);
} catch (err) {
  console.warn(err);
}

Example request

DeleteSparkEngineApplicationsOptions deleteSparkEngineApplicationsOptions = new DeleteSparkEngineApplicationsOptions.Builder()
  .engineId("testString")
  .applicationId("testString")
  .build();

Response<Void> response = watsonxDataService.deleteSparkEngineApplications(deleteSparkEngineApplicationsOptions).execute();

Example request

response = watsonx_data_service.delete_spark_engine_applications(
  engine_id='testString',
  application_id='testString',
)

Response

Status Code

204
No Content
400
Error
401
Unauthorized
404
Not found
500
Internal server error

No Sample Response

This method does not specify any sample responses.

Get status of spark application

Get status of spark application.

GET /spark_engines/{engine_id}/applications/{application_id}

(watsonxData *WatsonxDataV2) GetSparkEngineApplicationStatus(getSparkEngineApplicationStatusOptions *GetSparkEngineApplicationStatusOptions) (result *SparkEngineApplicationStatus, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) GetSparkEngineApplicationStatusWithContext(ctx context.Context, getSparkEngineApplicationStatusOptions *GetSparkEngineApplicationStatusOptions) (result *SparkEngineApplicationStatus, response *core.DetailedResponse, err error)

ServiceCall<SparkEngineApplicationStatus> getSparkEngineApplicationStatus(GetSparkEngineApplicationStatusOptions getSparkEngineApplicationStatusOptions)

get_spark_engine_application_status(
        self,
        engine_id: str,
        application_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

getSparkEngineApplicationStatus(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.spark_engine_application.get

Request

Instantiate the GetSparkEngineApplicationStatusOptions struct and set the fields to provide parameter values for the GetSparkEngineApplicationStatus method.

Use the GetSparkEngineApplicationStatusOptions.Builder to create a GetSparkEngineApplicationStatusOptions object that contains the parameter values for the getSparkEngineApplicationStatus method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+
application_id
Required*
string
Application id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

GetSparkEngineApplicationStatusOptions

The GetSparkEngineApplicationStatus options.

GetSparkEngineApplicationStatusOptions

The getSparkEngineApplicationStatus options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
application_id
Required*
str
Application id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
applicationId
Required*
string
Application id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X GET -H "content-type: application/json" -H "AuthInstanceId: {instance_id}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/spark_engines/{engine_id}/applications/{application_id}"

Example request

const params = {
  engineId: 'testString',
  applicationId: 'testString',
};

let res;
try {
  res = await watsonxDataService.getSparkEngineApplicationStatus(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

GetSparkEngineApplicationStatusOptions getSparkEngineApplicationStatusOptions = new GetSparkEngineApplicationStatusOptions.Builder()
  .engineId("testString")
  .applicationId("testString")
  .build();

Response<SparkEngineApplicationStatus> response = watsonxDataService.getSparkEngineApplicationStatus(getSparkEngineApplicationStatusOptions).execute();
SparkEngineApplicationStatus sparkEngineApplicationStatus = response.getResult();

System.out.println(sparkEngineApplicationStatus);

Example request

response = watsonx_data_service.get_spark_engine_application_status(
  engine_id='testString',
  application_id='testString',
)
spark_engine_application_status = response.get_result()

print(json.dumps(spark_engine_application_status, indent=2))

Response

Response Body

SparkEngineApplicationStatus

Engine Application Status

SparkEngineApplicationStatus

Engine Application Status.

Examples:

View

SparkEngineApplicationStatus

Engine Application Status.

Examples:

View

SparkEngineApplicationStatus

Engine Application Status.

Examples:

View

SparkEngineApplicationStatus

Engine Application Status.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "application": {
    "application_details": {
      "application": "/opt/xyz/spark/examples/src/main/python/wordcount.py",
      "arguments": [
        "/opt/xyz/spark/examples/src/main/python/people.txt"
      ],
      "conf": {
        "sparkConfPropKey1": "sparkConfPropvalue1",
        "sparkConfPropKey2": "sparkConfPropvalue2"
      },
      "env": {
        "sparkEnvPropKey1": "sparkEnvPropvalue1",
        "sparkEnvPropKey2": "sparkEnvPropvalue2"
      },
      "name": "SparkApplication1"
    },
    "application_id": "<application_id>",
    "auto_termination_time": "2023-11-04T15:37:57.775Z",
    "end_time": "2023-11-01T15:38:07.188Z",
    "id": "id-ca61-454c-aab3-486d39d8c1d0",
    "return_code": "1",
    "spark_application_id": "<spark_application_id>",
    "spark_application_name": "PythonWordCount",
    "start_time": "2023-11-01T15:37:57.775Z",
    "state": "failed",
    "state_details\"": [
      {
        "code": "server_error",
        "message": "A server error occurred while submitting or running your application.",
        "type": "server_error"
      }
    ],
    "submission_time": "2023-11-01T15:37:30.982Z"
  }
}

Success example

{
  "application": {
    "application_details": {
      "application": "/opt/xyz/spark/examples/src/main/python/wordcount.py",
      "arguments": [
        "/opt/xyz/spark/examples/src/main/python/people.txt"
      ],
      "conf": {
        "sparkConfPropKey1": "sparkConfPropvalue1",
        "sparkConfPropKey2": "sparkConfPropvalue2"
      },
      "env": {
        "sparkEnvPropKey1": "sparkEnvPropvalue1",
        "sparkEnvPropKey2": "sparkEnvPropvalue2"
      },
      "name": "SparkApplication1"
    },
    "application_id": "<application_id>",
    "auto_termination_time": "2023-11-04T15:37:57.775Z",
    "end_time": "2023-11-01T15:38:07.188Z",
    "id": "id-ca61-454c-aab3-486d39d8c1d0",
    "return_code": "1",
    "spark_application_id": "<spark_application_id>",
    "spark_application_name": "PythonWordCount",
    "start_time": "2023-11-01T15:37:57.775Z",
    "state": "failed",
    "state_details\"": [
      {
        "code": "server_error",
        "message": "A server error occurred while submitting or running your application.",
        "type": "server_error"
      }
    ],
    "submission_time": "2023-11-01T15:37:30.982Z"
  }
}

Verify lhconsole server is up and running

Verify lhconsole server is up and running.

GET /ready

(watsonxData *WatsonxDataV2) TestLHConsole(testLHConsoleOptions *TestLHConsoleOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) TestLHConsoleWithContext(ctx context.Context, testLHConsoleOptions *TestLHConsoleOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)

ServiceCall<SuccessResponse> testLHConsole()

test_lh_console(
        self,
        **kwargs,
    ) -> DetailedResponse

testLhConsole(params)

Request

No Request Parameters

This method does not accept any request parameters.

parameter

WithContext method only

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

curl example

curl -X GET -H "accept: application/json" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/ready"

Example request

let res;
try {
  res = await watsonxDataService.testLhConsole({});
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

TestLHConsoleOptions testLhConsoleOptions = new TestLHConsoleOptions();

Response<SuccessResponse> response = watsonxDataService.testLHConsole(testLhConsoleOptions).execute();
SuccessResponse successResponse = response.getResult();

System.out.println(successResponse);

Example request

response = watsonx_data_service.test_lh_console()
success_response = response.get_result()

print(json.dumps(success_response, indent=2))

Response

Response Body

SuccessResponse

Response of success

SuccessResponse

Response of success.

Examples:

View

SuccessResponse

Response of success.

Examples:

View

SuccessResponse

Response of success.

Examples:

View

SuccessResponse

Response of success.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "message": "Successful message",
  "message_code": "success"
}

Success example

{
  "message": "Successful message",
  "message_code": "success"
}

List all registered catalogs

List all registered catalogs.

GET /catalogs

(watsonxData *WatsonxDataV2) ListCatalogs(listCatalogsOptions *ListCatalogsOptions) (result *CatalogCollection, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) ListCatalogsWithContext(ctx context.Context, listCatalogsOptions *ListCatalogsOptions) (result *CatalogCollection, response *core.DetailedResponse, err error)

ServiceCall<CatalogCollection> listCatalogs(ListCatalogsOptions listCatalogsOptions)

list_catalogs(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

listCatalogs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.catalog.list

Request

Instantiate the ListCatalogsOptions struct and set the fields to provide parameter values for the ListCatalogs method.

Use the ListCatalogsOptions.Builder to create a ListCatalogsOptions object that contains the parameter values for the listCatalogs method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

parameter

WithContext method only

ListCatalogsOptions

The ListCatalogs options.

ListCatalogsOptions

The listCatalogs options.

parameters

auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'GET' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/catalogs' -H 'accept: application/json' -H 'AuthInstanceId: {instance_id}'

Example request

let res;
try {
  res = await watsonxDataService.listCatalogs({});
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

ListCatalogsOptions listCatalogsOptions = new ListCatalogsOptions.Builder()
  .build();

Response<CatalogCollection> response = watsonxDataService.listCatalogs(listCatalogsOptions).execute();
CatalogCollection catalogCollection = response.getResult();

System.out.println(catalogCollection);

Example request

response = watsonx_data_service.list_catalogs()
catalog_collection = response.get_result()

print(json.dumps(catalog_collection, indent=2))

Response

Response Body

CatalogCollection

GetCatalogs OK

CatalogCollection

GetCatalogs OK.

Examples:

View

CatalogCollection

GetCatalogs OK.

Examples:

View

CatalogCollection

GetCatalogs OK.

Examples:

View

CatalogCollection

GetCatalogs OK.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

{ "catalogs": [] }
{ "catalogs": [] }

Get catalog properties of a catalog identified by catalog_id

Get catalog properties of a catalog identified by catalog_id.

GET /catalogs/{catalog_id}

(watsonxData *WatsonxDataV2) GetCatalog(getCatalogOptions *GetCatalogOptions) (result *Catalog, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) GetCatalogWithContext(ctx context.Context, getCatalogOptions *GetCatalogOptions) (result *Catalog, response *core.DetailedResponse, err error)

ServiceCall<Catalog> getCatalog(GetCatalogOptions getCatalogOptions)

get_catalog(
        self,
        catalog_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

getCatalog(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.catalog.get

Request

Instantiate the GetCatalogOptions struct and set the fields to provide parameter values for the GetCatalog method.

Use the GetCatalogOptions.Builder to create a GetCatalogOptions object that contains the parameter values for the getCatalog method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

catalog_id
Required*
string
catalog ID

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-_]+

parameter

WithContext method only

GetCatalogOptions

The GetCatalog options.

GetCatalogOptions

The getCatalog options.

parameters

catalog_id
Required*
str
catalog ID.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

catalogId
Required*
string
catalog ID.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'GET' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/catalogs/{catalog_id}' -H 'accept: application/json' -H 'AuthInstanceId: {instance_id}'

Example request

const params = {
  catalogId: 'testString',
};

let res;
try {
  res = await watsonxDataService.getCatalog(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

GetCatalogOptions getCatalogOptions = new GetCatalogOptions.Builder()
  .catalogId("testString")
  .build();

Response<Catalog> response = watsonxDataService.getCatalog(getCatalogOptions).execute();
Catalog catalog = response.getResult();

System.out.println(catalog);

Example request

response = watsonx_data_service.get_catalog(
  catalog_id='testString',
)
catalog = response.get_result()

print(json.dumps(catalog, indent=2))

Response

Response Body

Catalog

Define the catalog details

Catalog

Define the catalog details.

Examples:

View

Catalog

Define the catalog details.

Examples:

View

Catalog

Define the catalog details.

Examples:

View

Catalog

Define the catalog details.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "actions": [
    "view",
    "update",
    "delete"
  ],
  "associated_buckets": [
    "ibm_cos_bucket"
  ],
  "associated_databases": [
    "iceberg_data"
  ],
  "associated_engines": [
    "presto367"
  ],
  "catalog_name": "iceberg_data",
  "catalog_type": "iceberg",
  "created_by": "user@domain.com",
  "created_on": "1700633239",
  "description": "catalog description",
  "hostname": "1234-xyz456-abc4321.lakehouse.dev.appdomain.cloud",
  "port": "31504",
  "sync_exception": [
    "table is corrupted",
    "table metadata not there"
  ],
  "tags": [
    "tag1",
    "tag2"
  ],
  "thrift_uri": "thrift://samplehost-catalog:4354"
}

Success example

{
  "actions": [
    "view",
    "update",
    "delete"
  ],
  "associated_buckets": [
    "ibm_cos_bucket"
  ],
  "associated_databases": [
    "iceberg_data"
  ],
  "associated_engines": [
    "presto367"
  ],
  "catalog_name": "iceberg_data",
  "catalog_type": "iceberg",
  "created_by": "user@domain.com",
  "created_on": "1700633239",
  "description": "catalog description",
  "hostname": "1234-xyz456-abc4321.lakehouse.dev.appdomain.cloud",
  "port": "31504",
  "sync_exception": [
    "table is corrupted",
    "table metadata not there"
  ],
  "tags": [
    "tag1",
    "tag2"
  ],
  "thrift_uri": "thrift://samplehost-catalog:4354"
}

List all schemas in catalog

List all schemas in catalog.

GET /catalogs/{catalog_id}/schemas

(watsonxData *WatsonxDataV2) ListSchemas(listSchemasOptions *ListSchemasOptions) (result *ListSchemasOKBody, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) ListSchemasWithContext(ctx context.Context, listSchemasOptions *ListSchemasOptions) (result *ListSchemasOKBody, response *core.DetailedResponse, err error)

ServiceCall<ListSchemasOKBody> listSchemas(ListSchemasOptions listSchemasOptions)

list_schemas(
        self,
        engine_id: str,
        catalog_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

listSchemas(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.schema.list

Request

Instantiate the ListSchemasOptions struct and set the fields to provide parameter values for the ListSchemas method.

Use the ListSchemasOptions.Builder to create a ListSchemasOptions object that contains the parameter values for the listSchemas method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

catalog_id
Required*
string
Catalog name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-_]+

Query Parameters

engine_id
Required*
string
Engine name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

ListSchemasOptions

The ListSchemas options.

ListSchemasOptions

The listSchemas options.

parameters

engine_id
Required*
str
Engine name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalog_id
Required*
str
Catalog name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
Engine name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalogId
Required*
string
Catalog name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'GET' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/catalogs/{catalog_id}/schemas?engine_id={engine_id}' -H 'accept: application/json' -H 'AuthInstanceId: {instance_id}'

Example request

const params = {
  engineId: 'testString',
  catalogId: 'testString',
};

let res;
try {
  res = await watsonxDataService.listSchemas(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

ListSchemasOptions listSchemasOptions = new ListSchemasOptions.Builder()
  .engineId("testString")
  .catalogId("testString")
  .build();

Response<ListSchemasOKBody> response = watsonxDataService.listSchemas(listSchemasOptions).execute();
ListSchemasOKBody listSchemasOkBody = response.getResult();

System.out.println(listSchemasOkBody);

Example request

response = watsonx_data_service.list_schemas(
  engine_id='testString',
  catalog_id='testString',
)
list_schemas_ok_body = response.get_result()

print(json.dumps(list_schemas_ok_body, indent=2))

Response

Response Body

ListSchemasOKBody

GetSchemas OK

ListSchemasOKBody

GetSchemas OK.

Examples:

View

ListSchemasOKBody

GetSchemas OK.

Examples:

View

ListSchemasOKBody

GetSchemas OK.

Examples:

View

ListSchemasOKBody

GetSchemas OK.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "response": {
    "message": "create schema",
    "message_code": "success"
  },
  "schemas": [
    "schema1",
    "schema2"
  ]
}

Success example

{
  "response": {
    "message": "create schema",
    "message_code": "success"
  },
  "schemas": [
    "schema1",
    "schema2"
  ]
}

Create a new schema

Create a new schema.

POST /catalogs/{catalog_id}/schemas

(watsonxData *WatsonxDataV2) CreateSchema(createSchemaOptions *CreateSchemaOptions) (result *CreateSchemaCreatedBody, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) CreateSchemaWithContext(ctx context.Context, createSchemaOptions *CreateSchemaOptions) (result *CreateSchemaCreatedBody, response *core.DetailedResponse, err error)

ServiceCall<CreateSchemaCreatedBody> createSchema(CreateSchemaOptions createSchemaOptions)

create_schema(
        self,
        engine_id: str,
        catalog_id: str,
        custom_path: str,
        schema_name: str,
        *,
        bucket_name: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

createSchema(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.schema.create

Request

Instantiate the CreateSchemaOptions struct and set the fields to provide parameter values for the CreateSchema method.

Use the CreateSchemaOptions.Builder to create a CreateSchemaOptions object that contains the parameter values for the createSchema method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

catalog_id
Required*
string
Catalog name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-_]+

Query Parameters

engine_id
Required*
string
Engine name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+

Request Body

Required*

CreateSchemaBody

Request body

parameter

WithContext method only

CreateSchemaOptions

The CreateSchema options.

CreateSchemaOptions

The createSchema options.

parameters

engine_id
Required*
str
Engine name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalog_id
Required*
str
Catalog name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
custom_path
Required*
str
Path associated with bucket.

Possible values: 0 ≤ length ≤ 2000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
schema_name
Required*
str
Schema name.

Possible values: 0 ≤ length ≤ 1024, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
bucket_name
str
Bucket associated to metastore where schema will be added.

Possible values: 0 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
Examples:
value
_source
_lines
_html
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
Engine name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalogId
Required*
string
Catalog name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
customPath
Required*
string
Path associated with bucket.

Possible values: 0 ≤ length ≤ 2000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
schemaName
Required*
string
Schema name.

Possible values: 0 ≤ length ≤ 1024, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
bucketName
string
Bucket associated to metastore where schema will be added.

Possible values: 0 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
Examples:
value
_source
_lines
_html
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'POST' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/catalogs/{catalog_id}/schemas?engine_id={engine_id}' -H 'accept: application/json' -H 'AuthInstanceId: {instance_id}' -H 'Content-Type: application/json' -d '{
  "bucket_name": "sample-bucket", 
  "custom_path": "sample-path", 
  "schema_name": "SampleSchema1" 
}'

Example request

const params = {
  engineId: 'testString',
  catalogId: 'testString',
  customPath: 'sample-path',
  schemaName: 'SampleSchema1',
};

let res;
try {
  res = await watsonxDataService.createSchema(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

CreateSchemaOptions createSchemaOptions = new CreateSchemaOptions.Builder()
  .engineId("testString")
  .catalogId("testString")
  .customPath("sample-path")
  .schemaName("SampleSchema1")
  .build();

Response<CreateSchemaCreatedBody> response = watsonxDataService.createSchema(createSchemaOptions).execute();
CreateSchemaCreatedBody createSchemaCreatedBody = response.getResult();

System.out.println(createSchemaCreatedBody);

Example request

response = watsonx_data_service.create_schema(
  engine_id='testString',
  catalog_id='testString',
  custom_path='sample-path',
  schema_name='SampleSchema1',
)
create_schema_created_body = response.get_result()

print(json.dumps(create_schema_created_body, indent=2))

Response

Response Body

CreateSchemaCreatedBody

success response

CreateSchemaCreatedBody

success response.

Examples:

View

CreateSchemaCreatedBody

success response.

Examples:

View

CreateSchemaCreatedBody

success response.

Examples:

View

CreateSchemaCreatedBody

success response.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "response": {
    "message": "create schema",
    "message_code": "success"
  }
}

Success example

{
  "response": {
    "message": "create schema",
    "message_code": "success"
  }
}

Delete a schema

Delete a schema.

DELETE /catalogs/{catalog_id}/schemas/{schema_id}

(watsonxData *WatsonxDataV2) DeleteSchema(deleteSchemaOptions *DeleteSchemaOptions) (response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) DeleteSchemaWithContext(ctx context.Context, deleteSchemaOptions *DeleteSchemaOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> deleteSchema(DeleteSchemaOptions deleteSchemaOptions)

delete_schema(
        self,
        engine_id: str,
        catalog_id: str,
        schema_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

deleteSchema(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.schema.delete

Request

Instantiate the DeleteSchemaOptions struct and set the fields to provide parameter values for the DeleteSchema method.

Use the DeleteSchemaOptions.Builder to create a DeleteSchemaOptions object that contains the parameter values for the deleteSchema method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

catalog_id
Required*
string
Catalog name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-_]+
schema_id
Required*
string
URL encoded Schema name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression .*

Query Parameters

engine_id
Required*
string
Engine name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

DeleteSchemaOptions

The DeleteSchema options.

DeleteSchemaOptions

The deleteSchema options.

parameters

engine_id
Required*
str
Engine name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalog_id
Required*
str
Catalog name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
schema_id
Required*
str
URL encoded Schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
Engine name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalogId
Required*
string
Catalog name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
schemaId
Required*
string
URL encoded Schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'DELETE' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/catalogs/{catalog_id}/schemas/{schema_id}?engine_id={engine_id}' -H 'accept: */*' -H 'AuthInstanceId: {instance_id}'

Example request

const params = {
  engineId: 'testString',
  catalogId: 'testString',
  schemaId: 'testString',
};

try {
  await watsonxDataService.deleteSchema(params);
} catch (err) {
  console.warn(err);
}

Example request

DeleteSchemaOptions deleteSchemaOptions = new DeleteSchemaOptions.Builder()
  .engineId("testString")
  .catalogId("testString")
  .schemaId("testString")
  .build();

Response<Void> response = watsonxDataService.deleteSchema(deleteSchemaOptions).execute();

Example request

response = watsonx_data_service.delete_schema(
  engine_id='testString',
  catalog_id='testString',
  schema_id='testString',
)

Response

Status Code

204
No Content
400
Error
401
Unauthorized
404
Not found
500
Internal server error

No Sample Response

This method does not specify any sample responses.

List all tables in a schema in a catalog for a given engine

List all tables in a schema in a catalog for a given engine.

GET /catalogs/{catalog_id}/schemas/{schema_id}/tables

(watsonxData *WatsonxDataV2) ListTables(listTablesOptions *ListTablesOptions) (result *TableCollection, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) ListTablesWithContext(ctx context.Context, listTablesOptions *ListTablesOptions) (result *TableCollection, response *core.DetailedResponse, err error)

ServiceCall<TableCollection> listTables(ListTablesOptions listTablesOptions)

list_tables(
        self,
        catalog_id: str,
        schema_id: str,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

listTables(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.table.list

Request

Instantiate the ListTablesOptions struct and set the fields to provide parameter values for the ListTables method.

Use the ListTablesOptions.Builder to create a ListTablesOptions object that contains the parameter values for the listTables method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

catalog_id
Required*
string
catalog id

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+
schema_id
Required*
string
URL encoded schema name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-%]+

Query Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

ListTablesOptions

The ListTables options.

ListTablesOptions

The listTables options.

parameters

catalog_id
Required*
str
catalog id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
schema_id
Required*
str
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-%]+/
engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

catalogId
Required*
string
catalog id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
schemaId
Required*
string
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-%]+/
engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'GET' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/catalogs/{catalog_id}/schemas/{schema_id}/tables?engine_id={engine_id}' -H 'accept: application/json' -H 'AuthInstanceId: {instance_id}'

Example request

const params = {
  catalogId: 'testString',
  schemaId: 'testString',
  engineId: 'testString',
};

let res;
try {
  res = await watsonxDataService.listTables(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

ListTablesOptions listTablesOptions = new ListTablesOptions.Builder()
  .catalogId("testString")
  .schemaId("testString")
  .engineId("testString")
  .build();

Response<TableCollection> response = watsonxDataService.listTables(listTablesOptions).execute();
TableCollection tableCollection = response.getResult();

System.out.println(tableCollection);

Example request

response = watsonx_data_service.list_tables(
  catalog_id='testString',
  schema_id='testString',
  engine_id='testString',
)
table_collection = response.get_result()

print(json.dumps(table_collection, indent=2))

Response

Response Body

TableCollection

tables list

TableCollection

tables list.

Examples:

View

TableCollection

tables list.

Examples:

View

TableCollection

tables list.

Examples:

View

TableCollection

tables list.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "tables": [
    "customer_data",
    "user_data"
  ]
}

Success example

{
  "tables": [
    "customer_data",
    "user_data"
  ]
}

Get details of a given table in a catalog and schema

Get details of a given table in a catalog and schema.

GET /catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}

(watsonxData *WatsonxDataV2) GetTable(getTableOptions *GetTableOptions) (result *Table, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) GetTableWithContext(ctx context.Context, getTableOptions *GetTableOptions) (result *Table, response *core.DetailedResponse, err error)

ServiceCall<Table> getTable(GetTableOptions getTableOptions)

get_table(
        self,
        catalog_id: str,
        schema_id: str,
        table_id: str,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

getTable(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.table.get

Request

Instantiate the GetTableOptions struct and set the fields to provide parameter values for the GetTable method.

Use the GetTableOptions.Builder to create a GetTableOptions object that contains the parameter values for the getTable method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

catalog_id
Required*
string
catalog id

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-_]+
schema_id
Required*
string
URL encoded schema name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression .*
table_id
Required*
string
URL encoded table name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression .*

Query Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

GetTableOptions

The GetTable options.

GetTableOptions

The getTable options.

parameters

catalog_id
Required*
str
catalog id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
schema_id
Required*
str
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
table_id
Required*
str
URL encoded table name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

catalogId
Required*
string
catalog id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
schemaId
Required*
string
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
tableId
Required*
string
URL encoded table name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'GET' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}?engine_id={engine_id}' -H 'accept: application/json' -H 'AuthInstanceId: {instance_id}'

Example request

const params = {
  catalogId: 'testString',
  schemaId: 'testString',
  tableId: 'testString',
  engineId: 'testString',
};

let res;
try {
  res = await watsonxDataService.getTable(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

GetTableOptions getTableOptions = new GetTableOptions.Builder()
  .catalogId("testString")
  .schemaId("testString")
  .tableId("testString")
  .engineId("testString")
  .build();

Response<Table> response = watsonxDataService.getTable(getTableOptions).execute();
Table table = response.getResult();

System.out.println(table);

Example request

response = watsonx_data_service.get_table(
  catalog_id='testString',
  schema_id='testString',
  table_id='testString',
  engine_id='testString',
)
table = response.get_result()

print(json.dumps(table, indent=2))

Response

Response Body

Table

GetColumns OK

Table

GetColumns OK.

Examples:

View

Table

GetColumns OK.

Examples:

View

Table

GetColumns OK.

Examples:

View

Table

GetColumns OK.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "columns": [
    {
      "column_name": "expenses",
      "comment": "expenses column",
      "extra": "varchar",
      "type": "varchar"
    }
  ],
  "table_name": "newtable,"
}

Success example

{
  "columns": [
    {
      "column_name": "expenses",
      "comment": "expenses column",
      "extra": "varchar",
      "type": "varchar"
    }
  ],
  "table_name": "newtable,"
}

Delete table for a given schema and catalog

Delete table for a given schema and catalog.

DELETE /catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}

(watsonxData *WatsonxDataV2) DeleteTable(deleteTableOptions *DeleteTableOptions) (response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) DeleteTableWithContext(ctx context.Context, deleteTableOptions *DeleteTableOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> deleteTable(DeleteTableOptions deleteTableOptions)

delete_table(
        self,
        catalog_id: str,
        schema_id: str,
        table_id: str,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

deleteTable(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.table.delete

Request

Instantiate the DeleteTableOptions struct and set the fields to provide parameter values for the DeleteTable method.

Use the DeleteTableOptions.Builder to create a DeleteTableOptions object that contains the parameter values for the deleteTable method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

catalog_id
Required*
string
catalog id

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-_]+
schema_id
Required*
string
URL encoded schema name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression .*
table_id
Required*
string
URL encoded table name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression .*

Query Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

DeleteTableOptions

The DeleteTable options.

DeleteTableOptions

The deleteTable options.

parameters

catalog_id
Required*
str
catalog id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
schema_id
Required*
str
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
table_id
Required*
str
URL encoded table name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

catalogId
Required*
string
catalog id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
schemaId
Required*
string
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
tableId
Required*
string
URL encoded table name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'DELETE' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}?engine_id={engine_id}' -H 'accept: */*' -H 'AuthInstanceId: {instance_id}'

Example request

const params = {
  catalogId: 'testString',
  schemaId: 'testString',
  tableId: 'testString',
  engineId: 'testString',
};

try {
  await watsonxDataService.deleteTable(params);
} catch (err) {
  console.warn(err);
}

Example request

DeleteTableOptions deleteTableOptions = new DeleteTableOptions.Builder()
  .catalogId("testString")
  .schemaId("testString")
  .tableId("testString")
  .engineId("testString")
  .build();

Response<Void> response = watsonxDataService.deleteTable(deleteTableOptions).execute();

Example request

response = watsonx_data_service.delete_table(
  catalog_id='testString',
  schema_id='testString',
  table_id='testString',
  engine_id='testString',
)

Response

Status Code

204
No Content
400
Error
401
Unauthorized
404
Not found
500
Internal server error

No Sample Response

This method does not specify any sample responses.

Rename table

Rename table.

PATCH /catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}

(watsonxData *WatsonxDataV2) UpdateTable(updateTableOptions *UpdateTableOptions) (result *Table, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) UpdateTableWithContext(ctx context.Context, updateTableOptions *UpdateTableOptions) (result *Table, response *core.DetailedResponse, err error)

ServiceCall<Table> updateTable(UpdateTableOptions updateTableOptions)

update_table(
        self,
        catalog_id: str,
        schema_id: str,
        table_id: str,
        engine_id: str,
        body: List['JsonPatchOperation'],
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

updateTable(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.table.update

Request

Instantiate the UpdateTableOptions struct and set the fields to provide parameter values for the UpdateTable method.

Use the UpdateTableOptions.Builder to create a UpdateTableOptions object that contains the parameter values for the updateTable method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

catalog_id
Required*
string
catalog id

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-_]+
schema_id
Required*
string
URL encoded schema name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression .*
table_id
Required*
string
URL encoded table name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression .*

Query Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+

Request Body

Required*

application/json-patch+jsonTablePatch

Request body

parameter

WithContext method only

UpdateTableOptions

The UpdateTable options.

UpdateTableOptions

The updateTable options.

parameters

catalog_id
Required*
str
catalog id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
schema_id
Required*
str
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
table_id
Required*
str
URL encoded table name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
body
Required*
List[JsonPatchOperation]
Request body.
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

catalogId
Required*
string
catalog id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
schemaId
Required*
string
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
tableId
Required*
string
URL encoded table name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
body
Required*
JsonPatchOperation[]
Request body.
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'PATCH' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}?engine_id={engine_id}' -H 'accept: application/json' -H 'AuthInstanceId: {instance_id}' -H 'Content-Type: application/json-patch+json' -d '{ 
  "new_table_name": "updated_table_name", 
}'

Example request

// Request models needed by this operation.

// JsonPatchOperation
const jsonPatchOperationModel = {
  op: 'add',
  path: 'testString',
};

const params = {
  catalogId: 'testString',
  schemaId: 'testString',
  tableId: 'testString',
  engineId: 'testString',
  body: [jsonPatchOperationModel],
};

let res;
try {
  res = await watsonxDataService.updateTable(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

JsonPatchOperation jsonPatchOperationModel = new JsonPatchOperation.Builder()
  .op("add")
  .path("testString")
  .build();
UpdateTableOptions updateTableOptions = new UpdateTableOptions.Builder()
  .catalogId("testString")
  .schemaId("testString")
  .tableId("testString")
  .engineId("testString")
  .body(java.util.Arrays.asList(jsonPatchOperationModel))
  .build();

Response<Table> response = watsonxDataService.updateTable(updateTableOptions).execute();
Table table = response.getResult();

System.out.println(table);

Example request

json_patch_operation_model = {
  'op': 'add',
  'path': 'testString',
}

response = watsonx_data_service.update_table(
  catalog_id='testString',
  schema_id='testString',
  table_id='testString',
  engine_id='testString',
  body=[json_patch_operation_model],
)
table = response.get_result()

print(json.dumps(table, indent=2))

Response

Response Body

Table

GetColumns OK

Table

GetColumns OK.

Examples:

View

Table

GetColumns OK.

Examples:

View

Table

GetColumns OK.

Examples:

View

Table

GetColumns OK.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "columns": [
    {
      "column_name": "expenses",
      "comment": "expenses column",
      "extra": "varchar",
      "type": "varchar"
    }
  ],
  "table_name": "newtable,"
}

Success example

{
  "columns": [
    {
      "column_name": "expenses",
      "comment": "expenses column",
      "extra": "varchar",
      "type": "varchar"
    }
  ],
  "table_name": "newtable,"
}

List all columns of a table in a given a schema for a given catalog

List all columns of a table in a given a schema for a given catalog.

GET /catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}/columns

(watsonxData *WatsonxDataV2) ListColumns(listColumnsOptions *ListColumnsOptions) (result *ColumnCollection, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) ListColumnsWithContext(ctx context.Context, listColumnsOptions *ListColumnsOptions) (result *ColumnCollection, response *core.DetailedResponse, err error)

ServiceCall<ColumnCollection> listColumns(ListColumnsOptions listColumnsOptions)

list_columns(
        self,
        engine_id: str,
        catalog_id: str,
        schema_id: str,
        table_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

listColumns(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.column.list

Request

Instantiate the ListColumnsOptions struct and set the fields to provide parameter values for the ListColumns method.

Use the ListColumnsOptions.Builder to create a ListColumnsOptions object that contains the parameter values for the listColumns method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

catalog_id
Required*
string
catalog id

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+
schema_id
Required*
string
URL encoded schema name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-%]+
table_id
Required*
string
URL encoded schema name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-%]+

Query Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

ListColumnsOptions

The ListColumns options.

ListColumnsOptions

The listColumns options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalog_id
Required*
str
catalog id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
schema_id
Required*
str
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-%]+/
table_id
Required*
str
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-%]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalogId
Required*
string
catalog id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
schemaId
Required*
string
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-%]+/
tableId
Required*
string
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-%]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'GET' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}/columns?engine_id={engine_id}' -H 'accept: application/json' -H 'AuthInstanceId: {instance_id}'

Example request

const params = {
  engineId: 'testString',
  catalogId: 'testString',
  schemaId: 'testString',
  tableId: 'testString',
};

let res;
try {
  res = await watsonxDataService.listColumns(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

ListColumnsOptions listColumnsOptions = new ListColumnsOptions.Builder()
  .engineId("testString")
  .catalogId("testString")
  .schemaId("testString")
  .tableId("testString")
  .build();

Response<ColumnCollection> response = watsonxDataService.listColumns(listColumnsOptions).execute();
ColumnCollection columnCollection = response.getResult();

System.out.println(columnCollection);

Example request

response = watsonx_data_service.list_columns(
  engine_id='testString',
  catalog_id='testString',
  schema_id='testString',
  table_id='testString',
)
column_collection = response.get_result()

print(json.dumps(column_collection, indent=2))

Response

Response Body

ColumnCollection

list of columns in a table

ColumnCollection

list of columns in a table.

Examples:

View

ColumnCollection

list of columns in a table.

Examples:

View

ColumnCollection

list of columns in a table.

Examples:

View

ColumnCollection

list of columns in a table.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "columns": [
    {
      "column_name": "customer_data"
    },
    {
      "column_name": "user_data"
    }
  ]
}

Success example

{
  "columns": [
    {
      "column_name": "customer_data"
    },
    {
      "column_name": "user_data"
    }
  ]
}

Add one or multiple columns to a table in a schema for a given catalog

Add one or multiple columns to a table in a schema for a given catalog.

POST /catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}/columns

(watsonxData *WatsonxDataV2) CreateColumns(createColumnsOptions *CreateColumnsOptions) (result *ColumnCollection, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) CreateColumnsWithContext(ctx context.Context, createColumnsOptions *CreateColumnsOptions) (result *ColumnCollection, response *core.DetailedResponse, err error)

ServiceCall<ColumnCollection> createColumns(CreateColumnsOptions createColumnsOptions)

create_columns(
        self,
        engine_id: str,
        catalog_id: str,
        schema_id: str,
        table_id: str,
        *,
        columns: Optional[List['Column']] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

createColumns(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.column.create

Request

Instantiate the CreateColumnsOptions struct and set the fields to provide parameter values for the CreateColumns method.

Use the CreateColumnsOptions.Builder to create a CreateColumnsOptions object that contains the parameter values for the createColumns method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

catalog_id
Required*
string
catalog id

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+
schema_id
Required*
string
URL encoded schema name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-%]+
table_id
Required*
string
URL encoded schema name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-%]+

Query Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+

Request Body

Required*

ColumnPrototype

Request body

Examples:

View

parameter

WithContext method only

CreateColumnsOptions

The CreateColumns options.

CreateColumnsOptions

The createColumns options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalog_id
Required*
str
catalog id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
schema_id
Required*
str
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-%]+/
table_id
Required*
str
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-%]+/
columns
List of the tables present in the schema.

Possible values: 0 ≤ number of items ≤ 1000000
Examples:
View
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalogId
Required*
string
catalog id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
schemaId
Required*
string
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-%]+/
tableId
Required*
string
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-%]+/
columns
List of the tables present in the schema.

Possible values: 0 ≤ number of items ≤ 1000000
Examples:
View
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'POST' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}/columns?engine_id={engine_id}' -H 'accept: application/json' -H 'AuthInstanceId: {instance_id}' -H 'Content-Type: application/json' -d '{
  "bucket_name": "sample-bucket", 
  "custom_path": "sample-path", 
  "schema_name": "SampleSchema1" 
}'

Example request

const params = {
  engineId: 'testString',
  catalogId: 'testString',
  schemaId: 'testString',
  tableId: 'testString',
};

let res;
try {
  res = await watsonxDataService.createColumns(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

CreateColumnsOptions createColumnsOptions = new CreateColumnsOptions.Builder()
  .engineId("testString")
  .catalogId("testString")
  .schemaId("testString")
  .tableId("testString")
  .build();

Response<ColumnCollection> response = watsonxDataService.createColumns(createColumnsOptions).execute();
ColumnCollection columnCollection = response.getResult();

System.out.println(columnCollection);

Example request

response = watsonx_data_service.create_columns(
  engine_id='testString',
  catalog_id='testString',
  schema_id='testString',
  table_id='testString',
)
column_collection = response.get_result()

print(json.dumps(column_collection, indent=2))

Response

Response Body

ColumnCollection

list of columns in a table

ColumnCollection

list of columns in a table.

Examples:

View

ColumnCollection

list of columns in a table.

Examples:

View

ColumnCollection

list of columns in a table.

Examples:

View

ColumnCollection

list of columns in a table.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "columns": [
    {
      "column_name": "customer_data"
    },
    {
      "column_name": "user_data"
    }
  ]
}

Success example

{
  "columns": [
    {
      "column_name": "customer_data"
    },
    {
      "column_name": "user_data"
    }
  ]
}

Delete column in a table for a given schema and catalog

Delete column in a table for a given schema and catalog.

DELETE /catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}/columns/{column_id}

(watsonxData *WatsonxDataV2) DeleteColumn(deleteColumnOptions *DeleteColumnOptions) (response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) DeleteColumnWithContext(ctx context.Context, deleteColumnOptions *DeleteColumnOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> deleteColumn(DeleteColumnOptions deleteColumnOptions)

delete_column(
        self,
        engine_id: str,
        catalog_id: str,
        schema_id: str,
        table_id: str,
        column_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

deleteColumn(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.column.delete

Request

Instantiate the DeleteColumnOptions struct and set the fields to provide parameter values for the DeleteColumn method.

Use the DeleteColumnOptions.Builder to create a DeleteColumnOptions object that contains the parameter values for the deleteColumn method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

catalog_id
Required*
string
catalog id

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+
schema_id
Required*
string
URL encoded schema name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-%]+
table_id
Required*
string
URL encoded schema name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-%]+
column_id
Required*
string
URL encoded schema name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-%]+

Query Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

DeleteColumnOptions

The DeleteColumn options.

DeleteColumnOptions

The deleteColumn options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalog_id
Required*
str
catalog id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
schema_id
Required*
str
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-%]+/
table_id
Required*
str
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-%]+/
column_id
Required*
str
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-%]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalogId
Required*
string
catalog id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
schemaId
Required*
string
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-%]+/
tableId
Required*
string
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-%]+/
columnId
Required*
string
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-%]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'DELETE' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}?engine_id={engine_id}' -H 'accept: */*' -H 'AuthInstanceId: {instance_id}'

Example request

const params = {
  engineId: 'testString',
  catalogId: 'testString',
  schemaId: 'testString',
  tableId: 'testString',
  columnId: 'testString',
};

try {
  await watsonxDataService.deleteColumn(params);
} catch (err) {
  console.warn(err);
}

Example request

DeleteColumnOptions deleteColumnOptions = new DeleteColumnOptions.Builder()
  .engineId("testString")
  .catalogId("testString")
  .schemaId("testString")
  .tableId("testString")
  .columnId("testString")
  .build();

Response<Void> response = watsonxDataService.deleteColumn(deleteColumnOptions).execute();

Example request

response = watsonx_data_service.delete_column(
  engine_id='testString',
  catalog_id='testString',
  schema_id='testString',
  table_id='testString',
  column_id='testString',
)

Response

Status Code

204
No Content
400
Error
401
Unauthorized
404
Not found
500
Internal server error

No Sample Response

This method does not specify any sample responses.

Update the given column - rename column

Update the given column - rename column.

PATCH /catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}/columns/{column_id}

(watsonxData *WatsonxDataV2) UpdateColumn(updateColumnOptions *UpdateColumnOptions) (result *Column, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) UpdateColumnWithContext(ctx context.Context, updateColumnOptions *UpdateColumnOptions) (result *Column, response *core.DetailedResponse, err error)

ServiceCall<Column> updateColumn(UpdateColumnOptions updateColumnOptions)

update_column(
        self,
        engine_id: str,
        catalog_id: str,
        schema_id: str,
        table_id: str,
        column_id: str,
        body: List['JsonPatchOperation'],
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

updateColumn(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.column.update

Request

Instantiate the UpdateColumnOptions struct and set the fields to provide parameter values for the UpdateColumn method.

Use the UpdateColumnOptions.Builder to create a UpdateColumnOptions object that contains the parameter values for the updateColumn method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

catalog_id
Required*
string
catalog id

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+
schema_id
Required*
string
URL encoded schema name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-%]+
table_id
Required*
string
URL encoded schema name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-%]+
column_id
Required*
string
URL encoded schema name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-%]+

Query Parameters

engine_id
Required*
string
engine id

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+

Request Body

Required*

application/json-patch+jsonColumnPatch

Request body

Examples:

View

parameter

WithContext method only

UpdateColumnOptions

The UpdateColumn options.

UpdateColumnOptions

The updateColumn options.

parameters

engine_id
Required*
str
engine id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalog_id
Required*
str
catalog id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
schema_id
Required*
str
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-%]+/
table_id
Required*
str
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-%]+/
column_id
Required*
str
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-%]+/
body
Required*
List[JsonPatchOperation]
Request body.
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
engine id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalogId
Required*
string
catalog id.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
schemaId
Required*
string
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-%]+/
tableId
Required*
string
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-%]+/
columnId
Required*
string
URL encoded schema name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-%]+/
body
Required*
JsonPatchOperation[]
Request body.
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'PATCH' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}?engine_id={engine_id}' -H 'accept: application/json' -H 'AuthInstanceId: {instance_id}' -H 'Content-Type: application/json-patch+json' -d '{ 
  "add_columns": [ 
    { 
      "column_comment": "income column", 
      "column_name": "income", 
      "data_type": "varchar" 
    } 
  ], 
  "drop_columns": [ 
    { 
      "column_name": "expenditure" 
    } 
  ], 
  "new_table_name": "updated_table_name", 
  "rename_columns": [ 
    { 
      "column_name": "expenditure", 
      "new_column_name": "expenses" 
    } 
  ] 
}'

Example request

// Request models needed by this operation.

// JsonPatchOperation
const jsonPatchOperationModel = {
  op: 'add',
  path: 'testString',
};

const params = {
  engineId: 'testString',
  catalogId: 'testString',
  schemaId: 'testString',
  tableId: 'testString',
  columnId: 'testString',
  body: [jsonPatchOperationModel],
};

let res;
try {
  res = await watsonxDataService.updateColumn(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

JsonPatchOperation jsonPatchOperationModel = new JsonPatchOperation.Builder()
  .op("add")
  .path("testString")
  .build();
UpdateColumnOptions updateColumnOptions = new UpdateColumnOptions.Builder()
  .engineId("testString")
  .catalogId("testString")
  .schemaId("testString")
  .tableId("testString")
  .columnId("testString")
  .body(java.util.Arrays.asList(jsonPatchOperationModel))
  .build();

Response<Column> response = watsonxDataService.updateColumn(updateColumnOptions).execute();
Column column = response.getResult();

System.out.println(column);

Example request

json_patch_operation_model = {
  'op': 'add',
  'path': 'testString',
}

response = watsonx_data_service.update_column(
  engine_id='testString',
  catalog_id='testString',
  schema_id='testString',
  table_id='testString',
  column_id='testString',
  body=[json_patch_operation_model],
)
column = response.get_result()

print(json.dumps(column, indent=2))

Response

Response Body

Column

Column.

Examples:

View

Column

Column.

Examples:

View

Column

Column.

Examples:

View

Column

Column.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "column_name": "expenses,",
  "comment": "expenses column",
  "extra": "varchar,",
  "type": "varchar,"
}

Success example

{
  "column_name": "expenses,",
  "comment": "expenses column",
  "extra": "varchar,",
  "type": "varchar,"
}

List all table snapshots

List all table snapshots.

GET /catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}/snapshots

(watsonxData *WatsonxDataV2) ListTableSnapshots(listTableSnapshotsOptions *ListTableSnapshotsOptions) (result *TableSnapshotCollection, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) ListTableSnapshotsWithContext(ctx context.Context, listTableSnapshotsOptions *ListTableSnapshotsOptions) (result *TableSnapshotCollection, response *core.DetailedResponse, err error)

ServiceCall<TableSnapshotCollection> listTableSnapshots(ListTableSnapshotsOptions listTableSnapshotsOptions)

list_table_snapshots(
        self,
        engine_id: str,
        catalog_id: str,
        schema_id: str,
        table_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

listTableSnapshots(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.table_snapshot.list

Request

Instantiate the ListTableSnapshotsOptions struct and set the fields to provide parameter values for the ListTableSnapshots method.

Use the ListTableSnapshotsOptions.Builder to create a ListTableSnapshotsOptions object that contains the parameter values for the listTableSnapshots method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

catalog_id
Required*
string
Catalog ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-_]+
schema_id
Required*
string
Schema ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression .*
table_id
Required*
string
Table ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression .*

Query Parameters

engine_id
Required*
string
Engine name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

ListTableSnapshotsOptions

The ListTableSnapshots options.

ListTableSnapshotsOptions

The listTableSnapshots options.

parameters

engine_id
Required*
str
Engine name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalog_id
Required*
str
Catalog ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
schema_id
Required*
str
Schema ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
table_id
Required*
str
Table ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
Engine name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalogId
Required*
string
Catalog ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
schemaId
Required*
string
Schema ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
tableId
Required*
string
Table ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'GET' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}/snapshots?engine_id={engine_id}' -H 'accept: application/json' -H 'AuthInstanceId: {instance_id}'

Example request

const params = {
  engineId: 'testString',
  catalogId: 'testString',
  schemaId: 'testString',
  tableId: 'testString',
};

let res;
try {
  res = await watsonxDataService.listTableSnapshots(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

ListTableSnapshotsOptions listTableSnapshotsOptions = new ListTableSnapshotsOptions.Builder()
  .engineId("testString")
  .catalogId("testString")
  .schemaId("testString")
  .tableId("testString")
  .build();

Response<TableSnapshotCollection> response = watsonxDataService.listTableSnapshots(listTableSnapshotsOptions).execute();
TableSnapshotCollection tableSnapshotCollection = response.getResult();

System.out.println(tableSnapshotCollection);

Example request

response = watsonx_data_service.list_table_snapshots(
  engine_id='testString',
  catalog_id='testString',
  schema_id='testString',
  table_id='testString',
)
table_snapshot_collection = response.get_result()

print(json.dumps(table_snapshot_collection, indent=2))

Response

Response Body

TableSnapshotCollection

TableSnapshot OK

TableSnapshotCollection

TableSnapshot OK.

Examples:

View

TableSnapshotCollection

TableSnapshot OK.

Examples:

View

TableSnapshotCollection

TableSnapshot OK.

Examples:

View

TableSnapshotCollection

TableSnapshot OK.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "snapshots": [
    {
      "committed_at": "1609379392",
      "operation": "alter",
      "snapshot_id": "2332342122211222",
      "summary": {}
    }
  ]
}

Success example

{
  "snapshots": [
    {
      "committed_at": "1609379392",
      "operation": "alter",
      "snapshot_id": "2332342122211222",
      "summary": {}
    }
  ]
}

Rollback to a table snapshot

Rollback to a table snapshot.

PUT /catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}/snapshots/{snapshot_id}

(watsonxData *WatsonxDataV2) ReplaceSnapshot(replaceSnapshotOptions *ReplaceSnapshotOptions) (result *ReplaceSnapshotCreatedBody, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) ReplaceSnapshotWithContext(ctx context.Context, replaceSnapshotOptions *ReplaceSnapshotOptions) (result *ReplaceSnapshotCreatedBody, response *core.DetailedResponse, err error)

ServiceCall<ReplaceSnapshotCreatedBody> replaceSnapshot(ReplaceSnapshotOptions replaceSnapshotOptions)

replace_snapshot(
        self,
        engine_id: str,
        catalog_id: str,
        schema_id: str,
        table_id: str,
        snapshot_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

replaceSnapshot(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.table_rollback.set

Request

Instantiate the ReplaceSnapshotOptions struct and set the fields to provide parameter values for the ReplaceSnapshot method.

Use the ReplaceSnapshotOptions.Builder to create a ReplaceSnapshotOptions object that contains the parameter values for the replaceSnapshot method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

catalog_id
Required*
string
Catalog ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+
schema_id
Required*
string
Schema ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression .*
table_id
Required*
string
Table ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression .*
snapshot_id
Required*
string
Snapshot ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+

Query Parameters

engine_id
Required*
string
Engine name

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

ReplaceSnapshotOptions

The ReplaceSnapshot options.

ReplaceSnapshotOptions

The replaceSnapshot options.

parameters

engine_id
Required*
str
Engine name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalog_id
Required*
str
Catalog ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
schema_id
Required*
str
Schema ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
table_id
Required*
str
Table ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
snapshot_id
Required*
str
Snapshot ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

engineId
Required*
string
Engine name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
catalogId
Required*
string
Catalog ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
schemaId
Required*
string
Schema ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
tableId
Required*
string
Table ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /.*/
snapshotId
Required*
string
Snapshot ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'PUT' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}/snapshots/{snapshot_id}?engine_id={engine_id}' -H 'accept: application/json' -H 'AuthInstanceId: {instance_id}'

Example request

const params = {
  engineId: 'testString',
  catalogId: 'testString',
  schemaId: 'testString',
  tableId: 'testString',
  snapshotId: 'testString',
};

let res;
try {
  res = await watsonxDataService.replaceSnapshot(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

ReplaceSnapshotOptions replaceSnapshotOptions = new ReplaceSnapshotOptions.Builder()
  .engineId("testString")
  .catalogId("testString")
  .schemaId("testString")
  .tableId("testString")
  .snapshotId("testString")
  .build();

Response<ReplaceSnapshotCreatedBody> response = watsonxDataService.replaceSnapshot(replaceSnapshotOptions).execute();
ReplaceSnapshotCreatedBody replaceSnapshotCreatedBody = response.getResult();

System.out.println(replaceSnapshotCreatedBody);

Example request

response = watsonx_data_service.replace_snapshot(
  engine_id='testString',
  catalog_id='testString',
  schema_id='testString',
  table_id='testString',
  snapshot_id='testString',
)
replace_snapshot_created_body = response.get_result()

print(json.dumps(replace_snapshot_created_body, indent=2))

Response

Response Body

ReplaceSnapshotCreatedBody

success response

ReplaceSnapshotCreatedBody

success response.

Examples:

View

ReplaceSnapshotCreatedBody

success response.

Examples:

View

ReplaceSnapshotCreatedBody

success response.

Examples:

View

ReplaceSnapshotCreatedBody

success response.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "response": {
    "message": "Rollback to a table snapshot",
    "message_code": "success"
  }
}

Success example

{
  "response": {
    "message": "Rollback to a table snapshot",
    "message_code": "success"
  }
}

Synchronize the external Iceberg table registration for a catalog identified by catalog_id.

PATCH /catalogs/{catalog_id}/sync

(watsonxData *WatsonxDataV2) UpdateSyncCatalog(updateSyncCatalogOptions *UpdateSyncCatalogOptions) (result *UpdateSyncCatalogOKBody, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) UpdateSyncCatalogWithContext(ctx context.Context, updateSyncCatalogOptions *UpdateSyncCatalogOptions) (result *UpdateSyncCatalogOKBody, response *core.DetailedResponse, err error)

ServiceCall<UpdateSyncCatalogOKBody> updateSyncCatalog(UpdateSyncCatalogOptions updateSyncCatalogOptions)

update_sync_catalog(
        self,
        catalog_id: str,
        body: List['JsonPatchOperation'],
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

updateSyncCatalog(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.catalog_sync.update

Request

Instantiate the UpdateSyncCatalogOptions struct and set the fields to provide parameter values for the UpdateSyncCatalog method.

Use the UpdateSyncCatalogOptions.Builder to create a UpdateSyncCatalogOptions object that contains the parameter values for the updateSyncCatalog method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

catalog_id
Required*
string
catalog ID

Possible values: 1 ≤ length ≤ 1000, Value must match regular expression ^[a-zA-Z0-9\-_]+

Request Body

Required*

application/json-patch+jsonSyncCatalogs

Request body

parameter

WithContext method only

UpdateSyncCatalogOptions

The UpdateSyncCatalog options.

UpdateSyncCatalogOptions

The updateSyncCatalog options.

parameters

catalog_id
Required*
str
catalog ID.

Possible values: 1 ≤ length ≤ 1000, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
body
Required*
List[JsonPatchOperation]
Request body.
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

catalogId
Required*
string
catalog ID.

Possible values: 1 ≤ length ≤ 1000, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
body
Required*
JsonPatchOperation[]
Request body.
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

curl example

curl -X 'PATCH' 'https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/catalogs/{catalog_id}/sync' -H 'accept: application/json' -H 'AuthInstanceId: {instance_id}' -H 'Content-Type: application/json-patch+json' -d '{ 
  "auto_add_new_tables": true, 
  "sync_iceberg_md": true 
}'

Example request

// Request models needed by this operation.

// JsonPatchOperation
const jsonPatchOperationModel = {
  op: 'add',
  path: 'testString',
};

const params = {
  catalogId: 'testString',
  body: [jsonPatchOperationModel],
};

let res;
try {
  res = await watsonxDataService.updateSyncCatalog(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

JsonPatchOperation jsonPatchOperationModel = new JsonPatchOperation.Builder()
  .op("add")
  .path("testString")
  .build();
UpdateSyncCatalogOptions updateSyncCatalogOptions = new UpdateSyncCatalogOptions.Builder()
  .catalogId("testString")
  .body(java.util.Arrays.asList(jsonPatchOperationModel))
  .build();

Response<UpdateSyncCatalogOKBody> response = watsonxDataService.updateSyncCatalog(updateSyncCatalogOptions).execute();
UpdateSyncCatalogOKBody updateSyncCatalogOkBody = response.getResult();

System.out.println(updateSyncCatalogOkBody);

Example request

json_patch_operation_model = {
  'op': 'add',
  'path': 'testString',
}

response = watsonx_data_service.update_sync_catalog(
  catalog_id='testString',
  body=[json_patch_operation_model],
)
update_sync_catalog_ok_body = response.get_result()

print(json.dumps(update_sync_catalog_ok_body, indent=2))

Response

Response Body

UpdateSyncCatalogOKBody

success response

UpdateSyncCatalogOKBody

success response.

Examples:

View

UpdateSyncCatalogOKBody

success response.

Examples:

View

UpdateSyncCatalogOKBody

success response.

Examples:

View

UpdateSyncCatalogOKBody

success response.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "response": {
    "message": "sync catalog",
    "message_code": "success"
  }
}

Success example

{
  "response": {
    "message": "sync catalog",
    "message_code": "success"
  }
}

Get list milvus services

Get list milvus services.

GET /milvus_services

(watsonxData *WatsonxDataV2) ListMilvusServices(listMilvusServicesOptions *ListMilvusServicesOptions) (result *MilvusServiceCollection, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) ListMilvusServicesWithContext(ctx context.Context, listMilvusServicesOptions *ListMilvusServicesOptions) (result *MilvusServiceCollection, response *core.DetailedResponse, err error)

ServiceCall<MilvusServiceCollection> listMilvusServices(ListMilvusServicesOptions listMilvusServicesOptions)

list_milvus_services(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

listMilvusServices(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.milvus_service.read

Request

Instantiate the ListMilvusServicesOptions struct and set the fields to provide parameter values for the ListMilvusServices method.

Use the ListMilvusServicesOptions.Builder to create a ListMilvusServicesOptions object that contains the parameter values for the listMilvusServices method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

parameter

WithContext method only

ListMilvusServicesOptions

The ListMilvusServices options.

ListMilvusServicesOptions

The listMilvusServices options.

parameters

auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

Example request

let res;
try {
  res = await watsonxDataService.listMilvusServices({});
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

ListMilvusServicesOptions listMilvusServicesOptions = new ListMilvusServicesOptions.Builder()
  .build();

Response<MilvusServiceCollection> response = watsonxDataService.listMilvusServices(listMilvusServicesOptions).execute();
MilvusServiceCollection milvusServiceCollection = response.getResult();

System.out.println(milvusServiceCollection);

Example request

response = watsonx_data_service.list_milvus_services()
milvus_service_collection = response.get_result()

print(json.dumps(milvus_service_collection, indent=2))

Response

Response Body

MilvusServiceCollection

List milvus services

MilvusServiceCollection

List milvus services.

Examples:

View

MilvusServiceCollection

List milvus services.

Examples:

View

MilvusServiceCollection

List milvus services.

Examples:

View

MilvusServiceCollection

List milvus services.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "milvus_services": [
    {
      "actions": [
        "update",
        "delete"
      ],
      "created_by": "username@domain.com",
      "created_on": 1700201877,
      "grpc_port": 31501,
      "host_name": "<formation_id>.<kubernetes_cluster>.databases.appdomain.cloud",
      "https_port": 31012,
      "service_display_name": "test-milvus",
      "service_id": "milvus76",
      "status": "running",
      "status_code": 11,
      "type": "milvus"
    }
  ]
}

Success example

{
  "milvus_services": [
    {
      "actions": [
        "update",
        "delete"
      ],
      "created_by": "username@domain.com",
      "created_on": 1700201877,
      "grpc_port": 31501,
      "host_name": "<formation_id>.<kubernetes_cluster>.databases.appdomain.cloud",
      "https_port": 31012,
      "service_display_name": "test-milvus",
      "service_id": "milvus76",
      "status": "running",
      "status_code": 11,
      "type": "milvus"
    }
  ]
}

Create milvus service

Create milvus service.

POST /milvus_services

(watsonxData *WatsonxDataV2) CreateMilvusService(createMilvusServiceOptions *CreateMilvusServiceOptions) (result *MilvusService, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) CreateMilvusServiceWithContext(ctx context.Context, createMilvusServiceOptions *CreateMilvusServiceOptions) (result *MilvusService, response *core.DetailedResponse, err error)

ServiceCall<MilvusService> createMilvusService(CreateMilvusServiceOptions createMilvusServiceOptions)

create_milvus_service(
        self,
        origin: str,
        type: str,
        *,
        description: Optional[str] = None,
        service_display_name: Optional[str] = None,
        tags: Optional[List[str]] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

createMilvusService(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.milvus_service.create

Request

Instantiate the CreateMilvusServiceOptions struct and set the fields to provide parameter values for the CreateMilvusService method.

Use the CreateMilvusServiceOptions.Builder to create a CreateMilvusServiceOptions object that contains the parameter values for the createMilvusService method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Request Body

Required*

MilvusServicePrototype

Create milvus service

parameter

WithContext method only

CreateMilvusServiceOptions

The CreateMilvusService options.

CreateMilvusServiceOptions

The createMilvusService options.

parameters

origin
Required*
str
Origin - place holder.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
type
Required*
str
service type.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
description
str
Service description.

Possible values: 0 ≤ length ≤ 1000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
service_display_name
str
Service display name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
tags
List[str]
Tags.

Possible values: 0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

origin
Required*
string
Origin - place holder.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
type
Required*
string
service type.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
description
string
Service description.

Possible values: 0 ≤ length ≤ 1000, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
serviceDisplayName
string
Service display name.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
Examples:
value
_source
_lines
_html
tags
string[]
Tags.

Possible values: 0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 128, Value must match regular expression /.*/
Examples:
value
_source
_lines
_html
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

Example request

const params = {
  origin: 'native',
  type: 'milvus',
};

let res;
try {
  res = await watsonxDataService.createMilvusService(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

CreateMilvusServiceOptions createMilvusServiceOptions = new CreateMilvusServiceOptions.Builder()
  .origin("native")
  .type("milvus")
  .build();

Response<MilvusService> response = watsonxDataService.createMilvusService(createMilvusServiceOptions).execute();
MilvusService milvusService = response.getResult();

System.out.println(milvusService);

Example request

response = watsonx_data_service.create_milvus_service(
  origin='native',
  type='milvus',
)
milvus_service = response.get_result()

print(json.dumps(milvus_service, indent=2))

Response

Response Body

MilvusService

milvus service details

MilvusService

milvus service details.

Examples:

View

MilvusService

milvus service details.

Examples:

View

MilvusService

milvus service details.

Examples:

View

MilvusService

milvus service details.

Examples:

View

Status Code

201
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 201

{
  "actions": [
    "update",
    "delete"
  ],
  "created_by": "username@domain.com",
  "created_on": 1700201877,
  "grpc_port": 31501,
  "host_name": "<formation_id>.<kubernetes_cluster>.databases.appdomain.cloud",
  "https_port": 31012,
  "milvus_service": null,
  "service_display_name": "test-milvus",
  "service_id": "milvus76",
  "status": "running",
  "status_code": 11,
  "type": "milvus"
}

Success example

{
  "actions": [
    "update",
    "delete"
  ],
  "created_by": "username@domain.com",
  "created_on": 1700201877,
  "grpc_port": 31501,
  "host_name": "<formation_id>.<kubernetes_cluster>.databases.appdomain.cloud",
  "https_port": 31012,
  "milvus_service": null,
  "service_display_name": "test-milvus",
  "service_id": "milvus76",
  "status": "running",
  "status_code": 11,
  "type": "milvus"
}

Get milvus service

Get milvus service.

GET /milvus_services/{service_id}

(watsonxData *WatsonxDataV2) GetMilvusService(getMilvusServiceOptions *GetMilvusServiceOptions) (result *MilvusService, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) GetMilvusServiceWithContext(ctx context.Context, getMilvusServiceOptions *GetMilvusServiceOptions) (result *MilvusService, response *core.DetailedResponse, err error)

ServiceCall<MilvusService> getMilvusService(GetMilvusServiceOptions getMilvusServiceOptions)

get_milvus_service(
        self,
        service_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

getMilvusService(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.milvus_service.get

Request

Instantiate the GetMilvusServiceOptions struct and set the fields to provide parameter values for the GetMilvusService method.

Use the GetMilvusServiceOptions.Builder to create a GetMilvusServiceOptions object that contains the parameter values for the getMilvusService method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

service_id
Required*
string
service id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

GetMilvusServiceOptions

The GetMilvusService options.

GetMilvusServiceOptions

The getMilvusService options.

parameters

service_id
Required*
str
service id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

serviceId
Required*
string
service id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

Example request

const params = {
  serviceId: 'testString',
};

let res;
try {
  res = await watsonxDataService.getMilvusService(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

GetMilvusServiceOptions getMilvusServiceOptions = new GetMilvusServiceOptions.Builder()
  .serviceId("testString")
  .build();

Response<MilvusService> response = watsonxDataService.getMilvusService(getMilvusServiceOptions).execute();
MilvusService milvusService = response.getResult();

System.out.println(milvusService);

Example request

response = watsonx_data_service.get_milvus_service(
  service_id='testString',
)
milvus_service = response.get_result()

print(json.dumps(milvus_service, indent=2))

Response

Response Body

MilvusService

milvus service details

MilvusService

milvus service details.

Examples:

View

MilvusService

milvus service details.

Examples:

View

MilvusService

milvus service details.

Examples:

View

MilvusService

milvus service details.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "actions": [
    "update",
    "delete"
  ],
  "created_by": "username@domain.com",
  "created_on": 1700201877,
  "grpc_port": 31501,
  "host_name": "<formation_id>.<kubernetes_cluster>.databases.appdomain.cloud",
  "https_port": 31012,
  "milvus_service": null,
  "service_display_name": "test-milvus",
  "service_id": "milvus76",
  "status": "running",
  "status_code": 11,
  "type": "milvus"
}

Success example

{
  "actions": [
    "update",
    "delete"
  ],
  "created_by": "username@domain.com",
  "created_on": 1700201877,
  "grpc_port": 31501,
  "host_name": "<formation_id>.<kubernetes_cluster>.databases.appdomain.cloud",
  "https_port": 31012,
  "milvus_service": null,
  "service_display_name": "test-milvus",
  "service_id": "milvus76",
  "status": "running",
  "status_code": 11,
  "type": "milvus"
}

Delete milvus service

Delete milvus service.

DELETE /milvus_services/{service_id}

(watsonxData *WatsonxDataV2) DeleteMilvusService(deleteMilvusServiceOptions *DeleteMilvusServiceOptions) (response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) DeleteMilvusServiceWithContext(ctx context.Context, deleteMilvusServiceOptions *DeleteMilvusServiceOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> deleteMilvusService(DeleteMilvusServiceOptions deleteMilvusServiceOptions)

delete_milvus_service(
        self,
        service_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

deleteMilvusService(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.milvus_service.delete

Request

Instantiate the DeleteMilvusServiceOptions struct and set the fields to provide parameter values for the DeleteMilvusService method.

Use the DeleteMilvusServiceOptions.Builder to create a DeleteMilvusServiceOptions object that contains the parameter values for the deleteMilvusService method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

service_id
Required*
string
service id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

parameter

WithContext method only

DeleteMilvusServiceOptions

The DeleteMilvusService options.

DeleteMilvusServiceOptions

The deleteMilvusService options.

parameters

service_id
Required*
str
service id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

serviceId
Required*
string
service id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

Example request

const params = {
  serviceId: 'testString',
};

try {
  await watsonxDataService.deleteMilvusService(params);
} catch (err) {
  console.warn(err);
}

Example request

DeleteMilvusServiceOptions deleteMilvusServiceOptions = new DeleteMilvusServiceOptions.Builder()
  .serviceId("testString")
  .build();

Response<Void> response = watsonxDataService.deleteMilvusService(deleteMilvusServiceOptions).execute();

Example request

response = watsonx_data_service.delete_milvus_service(
  service_id='testString',
)

Response

Status Code

204
No Content
400
Error
401
Unauthorized
404
Not found
500
Internal server error

No Sample Response

This method does not specify any sample responses.

Update details of milvus service

Update details of milvus service.

PATCH /milvus_services/{service_id}

(watsonxData *WatsonxDataV2) UpdateMilvusService(updateMilvusServiceOptions *UpdateMilvusServiceOptions) (result *MilvusService, response *core.DetailedResponse, err error)

(watsonxData *WatsonxDataV2) UpdateMilvusServiceWithContext(ctx context.Context, updateMilvusServiceOptions *UpdateMilvusServiceOptions) (result *MilvusService, response *core.DetailedResponse, err error)

ServiceCall<MilvusService> updateMilvusService(UpdateMilvusServiceOptions updateMilvusServiceOptions)

update_milvus_service(
        self,
        service_id: str,
        body: List['JsonPatchOperation'],
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse

updateMilvusService(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

lakehouse.milvus_service.update

Request

Instantiate the UpdateMilvusServiceOptions struct and set the fields to provide parameter values for the UpdateMilvusService method.

Use the UpdateMilvusServiceOptions.Builder to create a UpdateMilvusServiceOptions object that contains the parameter values for the updateMilvusService method.

Custom Headers

AuthInstanceId
string
Instance ID

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$

Path Parameters

service_id
Required*
string
service id

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+

Request Body

Required*

application/json-patch+jsonMilvusServicePatch

Update milvus service

parameter

WithContext method only

UpdateMilvusServiceOptions

The UpdateMilvusService options.

UpdateMilvusServiceOptions

The updateMilvusService options.

parameters

service_id
Required*
str
service id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
body
Required*
List[JsonPatchOperation]
Update milvus service.
auth_instance_id
str
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

parameters

serviceId
Required*
string
service id.

Possible values: 1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
body
Required*
JsonPatchOperation[]
Update milvus service.
authInstanceId
string
Instance ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/

Example request

// Request models needed by this operation.

// JsonPatchOperation
const jsonPatchOperationModel = {
  op: 'add',
  path: 'testString',
};

const params = {
  serviceId: 'testString',
  body: [jsonPatchOperationModel],
};

let res;
try {
  res = await watsonxDataService.updateMilvusService(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

Example request

JsonPatchOperation jsonPatchOperationModel = new JsonPatchOperation.Builder()
  .op("add")
  .path("testString")
  .build();
UpdateMilvusServiceOptions updateMilvusServiceOptions = new UpdateMilvusServiceOptions.Builder()
  .serviceId("testString")
  .body(java.util.Arrays.asList(jsonPatchOperationModel))
  .build();

Response<MilvusService> response = watsonxDataService.updateMilvusService(updateMilvusServiceOptions).execute();
MilvusService milvusService = response.getResult();

System.out.println(milvusService);

Example request

json_patch_operation_model = {
  'op': 'add',
  'path': 'testString',
}

response = watsonx_data_service.update_milvus_service(
  service_id='testString',
  body=[json_patch_operation_model],
)
milvus_service = response.get_result()

print(json.dumps(milvus_service, indent=2))

Response

Response Body

MilvusService

milvus service details

MilvusService

milvus service details.

Examples:

View

MilvusService

milvus service details.

Examples:

View

MilvusService

milvus service details.

Examples:

View

MilvusService

milvus service details.

Examples:

View

Status Code

200
Success
400
Error
401
Unauthorized
404
Not found
500
Internal server error

Example responses

Status 200

{
  "actions": [
    "update",
    "delete"
  ],
  "created_by": "username@domain.com",
  "created_on": 1700201877,
  "grpc_port": 31501,
  "host_name": "<formation_id>.<kubernetes_cluster>.databases.appdomain.cloud",
  "https_port": 31012,
  "milvus_service": null,
  "service_display_name": "test-milvus",
  "service_id": "milvus76",
  "status": "running",
  "status_code": 11,
  "type": "milvus"
}

Success example

{
  "actions": [
    "update",
    "delete"
  ],
  "created_by": "username@domain.com",
  "created_on": 1700201877,
  "grpc_port": 31501,
  "host_name": "<formation_id>.<kubernetes_cluster>.databases.appdomain.cloud",
  "https_port": 31012,
  "milvus_service": null,
  "service_display_name": "test-milvus",
  "service_id": "milvus76",
  "status": "running",
  "status_code": 11,
  "type": "milvus"
}

Introduction

Endpoint URLs

Authentication

Auditing

Error handling

Pagination

Methods

Get bucket registrations

Authorization

Request

Custom Headers

AuthInstanceId

parameter

ctx

ListBucketRegistrationsOptions

AuthInstanceID

ListBucketRegistrationsOptions

authInstanceId

parameters

auth_instance_id

parameters

authInstanceId

Response

Response Body

bucket_registrations

BucketRegistrationCollection

BucketRegistrations

Actions

AssociatedCatalog

CatalogName

CatalogTags

CatalogType

BucketDetails

AccessKey

BucketName

Endpoint

SecretKey

BucketDisplayName

BucketID

BucketType

CreatedBy

CreatedOn

Description

ManagedBy

Region

State

Tags

BucketRegistrationCollection

bucketRegistrations

actions

associatedCatalog

catalogName

catalogTags

catalogType

bucketDetails

accessKey

bucketName

endpoint

secretKey

bucketDisplayName

bucketId

bucketType

createdBy

createdOn

description

managedBy

region

state

tags

BucketRegistrationCollection

bucket_registrations

actions

associated_catalog

catalog_name

catalog_tags

catalog_type

bucket_details

access_key

bucket_name

endpoint