Watson Query | IBM Cloud API Docs

Introduction

Last updated: 2021-12-07

Watson Query integrates data sources across multiple types and locations and turns all this data into one logical data view.

The Watson Query REST API connects to your service, so you can manage your virtual data, data sources, and user roles.

Endpoint URLs

Identify the base URL for your service instance.

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

Before you can call an IBM Watson Query API, you must create an IAM bearer token. Each token is valid for one hour. After a token expires, you must create a new one if you want to continue to use the API. The method to retrieve a token programmatically is to create an API key for your IBM Cloud identity and then use the API key call IAM API to generate a bearer token.

If the API key is zVxeuKGuf2i2lXhdHm25kg38BHOKNhhGQ2QySxgH9iuP, the generate command looks like this:

curl -X POST 'https://iam.cloud.ibm.com/identity/token' -H 'Content-Type: application/x-www-form-urlencoded' -d 'grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=zVxeuKGuf2i2lXhdHm25kg38BHOKNhhGQ2QySxgH9iuP'

An X-Db-Profile is also required when you call an IBM Watson Query API. This profile represents which instance the request is for. For example:

 crn%3Av1%3Astaging%3Apublic%3Adata-virtualization%3Aus-south%3Aa%AorQ%CX3VpfQ7GXqj84Gii91c7cBp%zia7aoSN3mXvD2u-jTVQ-1rKj-zEo7-5Ue8jePrP6JblQj2eS

The following example shows a complete API call.

curl -X GET "https://us-south.data-virtualization.cloud.ibm.com/dvapiserver/v2/datasource/connections" -H "X-Db-Profile: $url_encoded_crn" -H "Authorization: Bearer $token"

After you get the bearer token, pass the token in the request header, the user will be authorized to access Watson Query API services.

Error handling

Watson Query uses standard HTTP response codes to indicate whether a method completed successfully. HTTP response codes in the 2xx range indicate success. A response in the 4xx range is some sort of failure, and a response in the 5xx range usually indicates an internal system error that cannot be resolved by the user. Response codes are listed with the method.

ErrorResponse

Name	Description
code{: .parameter-name .required} string	An identifier of the response.
message{: .parameter-name .required} string	An explanation of the problem.

Watson Query docs
Cloud Pak for Data APIs and SDKs
Cloud Pak for Data as a Service APIs and SDKs

Gets all data source connections that are connected to the service.

GET /dvapiserver/v2/datasource/connections

(watsonQuery *WatsonQueryV1) ListDatasourceConnections(listDatasourceConnectionsOptions *ListDatasourceConnectionsOptions) (result *DatasourceConnectionsList, response *core.DetailedResponse, err error)

(watsonQuery *WatsonQueryV1) ListDatasourceConnectionsWithContext(ctx context.Context, listDatasourceConnectionsOptions *ListDatasourceConnectionsOptions) (result *DatasourceConnectionsList, response *core.DetailedResponse, err error)

ServiceCall<DatasourceConnectionsList> listDatasourceConnections()

list_datasource_connections(self,
        **kwargs
    ) -> DetailedResponse

listDatasourceConnections(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.

Example request

curl -k -X GET "https://{region}.data-virtualization.cloud.ibm.com/dvapiserver/v2/datasource/connections"

Example request

listDatasourceConnectionsOptions := watsonQueryService.NewListDatasourceConnectionsOptions()

datasourceConnectionsList, response, err := watsonQueryService.ListDatasourceConnections(listDatasourceConnectionsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(datasourceConnectionsList, "", "  ")
fmt.Println(string(b))

Example request

ListDatasourceConnectionsOptions listDatasourceConnectionsOptions = new ListDatasourceConnectionsOptions();

Response<DatasourceConnectionsList> response = watsonQueryService.listDatasourceConnections(listDatasourceConnectionsOptions).execute();
DatasourceConnectionsList datasourceConnectionsList = response.getResult();

System.out.println(datasourceConnectionsList);

Example request

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

Example request

datasource_connections_list = watson_query_service.list_datasource_connections().get_result()

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

Response

Response Body

DatasourceConnectionsList

Status Code

200
Success
400
Bad Request
401
Unauthorized
500
Internal Server Error

Example responses

Status 200

{
  "datasource_connections": [
    {
      "agent_class": "F",
      "dscount": "0",
      "hostname": "dv-0.dv.tns.svc.cluster.local",
      "is_docker": "N",
      "node_name": "AdminNode",
      "node_description": "Not specified",
      "port": "6414",
      "os_user": "bigsql",
      "data_sources": [
        {
          "cid": "MSSQL10000",
          "dbname": "mssql2014db1",
          "connection_id": "75e4d01b-7417-4abc-b267-8ffb393fb970",
          "srchostname": "example.ibm.com",
          "srcport": "1433",
          "srctype": "MSSQLServer",
          "status": "string",
          "usr": "DV-user",
          "uri": "example.ibm.com:1433/"
        }
      ]
    }
  ]
}

Success example

{
  "datasource_connections": [
    {
      "agent_class": "F",
      "dscount": "0",
      "hostname": "dv-0.dv.tns.svc.cluster.local",
      "is_docker": "N",
      "node_name": "AdminNode",
      "node_description": "Not specified",
      "port": "6414",
      "os_user": "bigsql",
      "data_sources": [
        {
          "cid": "MSSQL10000",
          "dbname": "mssql2014db1",
          "connection_id": "75e4d01b-7417-4abc-b267-8ffb393fb970",
          "srchostname": "example.ibm.com",
          "srcport": "1433",
          "srctype": "MSSQLServer",
          "status": "string",
          "usr": "DV-user",
          "uri": "example.ibm.com:1433/"
        }
      ]
    }
  ]
}

Adds a data source connection to the Watson Query service.

POST /dvapiserver/v2/datasource/connections

(watsonQuery *WatsonQueryV1) AddDatasourceConnection(addDatasourceConnectionOptions *AddDatasourceConnectionOptions) (result *PostDatasourceConnection, response *core.DetailedResponse, err error)

(watsonQuery *WatsonQueryV1) AddDatasourceConnectionWithContext(ctx context.Context, addDatasourceConnectionOptions *AddDatasourceConnectionOptions) (result *PostDatasourceConnection, response *core.DetailedResponse, err error)

ServiceCall<PostDatasourceConnection> addDatasourceConnection(AddDatasourceConnectionOptions addDatasourceConnectionOptions)

add_datasource_connection(self,
        datasource_type: str,
        name: str,
        origin_country: str,
        properties: 'PostDatasourceConnectionParametersProperties',
        *,
        asset_category: str = None,
        **kwargs
    ) -> DetailedResponse

addDatasourceConnection(params)

Request

Instantiate the AddDatasourceConnectionOptions struct and set the fields to provide parameter values for the AddDatasourceConnection method.

Use the AddDatasourceConnectionOptions.Builder to create a AddDatasourceConnectionOptions object that contains the parameter values for the addDatasourceConnection method.

Request Body

Required*

PostDatasourceConnectionParameters

parameter

WithContext method only

AddDatasourceConnectionOptions

The AddDatasourceConnection options.

AddDatasourceConnectionOptions

The addDatasourceConnection options.

parameters

datasource_type
Required*
str
The type of data source that you want to add.

Examples:
value
_source
_lines
_html
name
Required*
str
The name of the data source.

Examples:
value
_source
_lines
_html
origin_country
Required*
str
The location of the data source that you want to add.

Examples:
value
_source
_lines
_html
properties
asset_category
str
Examples:
value
_source
_lines
_html

parameters

datasourceType
Required*
string
The type of data source that you want to add.

Examples:
value
_source
_lines
_html
name
Required*
string
The name of the data source.

Examples:
value
_source
_lines
_html
originCountry
Required*
string
The location of the data source that you want to add.

Examples:
value
_source
_lines
_html
properties
assetCategory
string
Examples:
value
_source
_lines
_html

Example request

curl -k -X POST -H "cache-control: no-cache" -H "content-type: application/json" -H "X-Db-Profile: $url_encoded_crn" -H "Authorization: Bearer $token" -d "{\"datasource_type\":\"Db2\",\"name\":\"Db2\",\"origin_country\":\"us\",\"properties\":{\"database\":\"TPDCS\",\"host\":\"{hostname}\", \"password\":\"myPassword\", \"port\":\"50000\", \"ssl\":\"true\", \"username\":\"DV-user\"}}" "https://{region}.data-virtualization.cloud.ibm.com/dvapiserver/v2/datasource/connections"

Example request

postDatasourceConnectionParametersPropertiesModel := &watsonqueryv1.PostDatasourceConnectionParametersProperties{
}

addDatasourceConnectionOptions := watsonQueryService.NewAddDatasourceConnectionOptions(
  "DB2",
  "DB2",
  "us",
  postDatasourceConnectionParametersPropertiesModel,
)

postDatasourceConnection, response, err := watsonQueryService.AddDatasourceConnection(addDatasourceConnectionOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(postDatasourceConnection, "", "  ")
fmt.Println(string(b))

Example request

PostDatasourceConnectionParametersProperties postDatasourceConnectionParametersPropertiesModel = new PostDatasourceConnectionParametersProperties.Builder()
  .build();
AddDatasourceConnectionOptions addDatasourceConnectionOptions = new AddDatasourceConnectionOptions.Builder()
  .datasourceType("DB2")
  .name("DB2")
  .originCountry("us")
  .xProperties(postDatasourceConnectionParametersPropertiesModel)
  .build();

Response<PostDatasourceConnection> response = watsonQueryService.addDatasourceConnection(addDatasourceConnectionOptions).execute();
PostDatasourceConnection postDatasourceConnection = response.getResult();

System.out.println(postDatasourceConnection);

Example request

// Request models needed by this operation.

// PostDatasourceConnectionParametersProperties
const postDatasourceConnectionParametersPropertiesModel = {
};

const params = {
  datasourceType: 'DB2',
  name: 'DB2',
  originCountry: 'us',
  properties: postDatasourceConnectionParametersPropertiesModel,
};

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

Example request

post_datasource_connection_parameters_properties_model = {
}

post_datasource_connection = watson_query_service.add_datasource_connection(
  datasource_type='DB2',
  name='DB2',
  origin_country='us',
  properties=post_datasource_connection_parameters_properties_model
).get_result()

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

Response

Response Body

PostDatasourceConnection

Status Code

201
Created
400
Bad Request
401
Unauthorized
409
Conflict
500
Internal Server Error

No Sample Response

This method does not specify any sample responses.

Deletes a data source connection from the Watson Query service.

DELETE /dvapiserver/v2/datasource/connections/{connection_id}

(watsonQuery *WatsonQueryV1) DeleteDatasourceConnection(deleteDatasourceConnectionOptions *DeleteDatasourceConnectionOptions) (response *core.DetailedResponse, err error)

(watsonQuery *WatsonQueryV1) DeleteDatasourceConnectionWithContext(ctx context.Context, deleteDatasourceConnectionOptions *DeleteDatasourceConnectionOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> deleteDatasourceConnection(DeleteDatasourceConnectionOptions deleteDatasourceConnectionOptions)

delete_datasource_connection(self,
        connection_id: str,
        *,
        cid: str = None,
        **kwargs
    ) -> DetailedResponse

deleteDatasourceConnection(params)

Request

Instantiate the DeleteDatasourceConnectionOptions struct and set the fields to provide parameter values for the DeleteDatasourceConnection method.

Use the DeleteDatasourceConnectionOptions.Builder to create a DeleteDatasourceConnectionOptions object that contains the parameter values for the deleteDatasourceConnection method.

Path Parameters

connection_id
Required*
string
The connection identifier for the platform.

Example: 75e4d01b-7417-4abc-b267-8ffb393fb970

Query Parameters

cid
string
The connection identifier for Watson Query.

Example: DB210013

parameter

WithContext method only

DeleteDatasourceConnectionOptions

The DeleteDatasourceConnection options.

DeleteDatasourceConnectionOptions

The deleteDatasourceConnection options.

parameters

connection_id
Required*
str
The connection identifier for the platform.

Examples:
value
_source
_lines
_html
cid
str
The connection identifier for Watson Query.

Examples:
value
_source
_lines
_html

parameters

connectionId
Required*
string
The connection identifier for the platform.

Examples:
value
_source
_lines
_html
cid
string
The connection identifier for Watson Query.

Examples:
value
_source
_lines
_html

Example request

curl -k -X DELETE -H "cache-control: no-cache" -H "content-type: application/json" -H "X-Db-Profile: $url_encoded_crn" -H "Authorization: Bearer $token" "https://{region}.data-virtualization.cloud.ibm.com/dvapiserver/v2/datasource/connections/75e4d01b-7417-4abc-b267-8ffb393fb970?cid=DB210013"

Example request

deleteDatasourceConnectionOptions := watsonQueryService.NewDeleteDatasourceConnectionOptions(
  "75e4d01b-7417-4abc-b267-8ffb393fb970",
)
deleteDatasourceConnectionOptions.SetCid("DB210013")

response, err := watsonQueryService.DeleteDatasourceConnection(deleteDatasourceConnectionOptions)
if err != nil {
  panic(err)
}

Example request

DeleteDatasourceConnectionOptions deleteDatasourceConnectionOptions = new DeleteDatasourceConnectionOptions.Builder()
  .connectionId("75e4d01b-7417-4abc-b267-8ffb393fb970")
  .cid("DB210013")
  .build();

Response<Void> response = watsonQueryService.deleteDatasourceConnection(deleteDatasourceConnectionOptions).execute();

Example request

const params = {
  connectionId: '75e4d01b-7417-4abc-b267-8ffb393fb970',
  cid: 'DB210013',
};

try {
  await watsonQueryService.deleteDatasourceConnection(params);
} catch (err) {
  console.warn(err);
}

Example request

response = watson_query_service.delete_datasource_connection(
  connection_id='75e4d01b-7417-4abc-b267-8ffb393fb970',
  cid='DB210013'
)

Response

Status Code

204
Success
400
Bad Request
401
Unauthorized
500
Internal Server Error

No Sample Response

This method does not specify any sample responses.

GET /dvapiserver/v2/datasource/objectstore_connections

(watsonQuery *WatsonQueryV1) GetObjectStoreConnectionsV2(getObjectStoreConnectionsV2Options *GetObjectStoreConnectionsV2Options) (result *ObjStoreConnectionResponseV2, response *core.DetailedResponse, err error)

(watsonQuery *WatsonQueryV1) GetObjectStoreConnectionsV2WithContext(ctx context.Context, getObjectStoreConnectionsV2Options *GetObjectStoreConnectionsV2Options) (result *ObjStoreConnectionResponseV2, response *core.DetailedResponse, err error)

ServiceCall<ObjStoreConnectionResponseV2> getObjectStoreConnectionsV2(GetObjectStoreConnectionsV2Options getObjectStoreConnectionsV2Options)

get_object_store_connections_v2(self,
        *,
        jwt_auth_user_payload: str = None,
        **kwargs
    ) -> DetailedResponse

getObjectStoreConnectionsV2(params)

Request

Instantiate the GetObjectStoreConnectionsV2Options struct and set the fields to provide parameter values for the GetObjectStoreConnectionsV2 method.

Use the GetObjectStoreConnectionsV2Options.Builder to create a GetObjectStoreConnectionsV2Options object that contains the parameter values for the getObjectStoreConnectionsV2 method.

Custom Headers

jwt-auth-user-payload
string
Supplied by proxy. Do NOT add your own value.

parameter

WithContext method only

GetObjectStoreConnectionsV2Options

The GetObjectStoreConnectionsV2 options.

GetObjectStoreConnectionsV2Options

The getObjectStoreConnectionsV2 options.

parameters

jwt_auth_user_payload
str
Supplied by proxy. Do NOT add your own value.

parameters

jwtAuthUserPayload
string
Supplied by proxy. Do NOT add your own value.

Example request

curl -k -X GET -H "cache-control: no-cache" -H "content-type: application/json" -H "X-Db-Profile: $url_encoded_crn" -H "Authorization: Bearer $token" "https://{region}.data-virtualization.cloud.ibm.com/dvapiserver/v2/datasource/objectstore_connections"

Example request

getObjectStoreConnectionsV2Options := watsonQueryService.NewGetObjectStoreConnectionsV2Options()

objStoreConnectionResponseV2, response, err := watsonQueryService.GetObjectStoreConnectionsV2(getObjectStoreConnectionsV2Options)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(objStoreConnectionResponseV2, "", "  ")
fmt.Println(string(b))

Example request

GetObjectStoreConnectionsV2Options getObjectStoreConnectionsV2Options = new GetObjectStoreConnectionsV2Options.Builder()
  .build();

Response<ObjStoreConnectionResponseV2> response = watsonQueryService.getObjectStoreConnectionsV2(getObjectStoreConnectionsV2Options).execute();
ObjStoreConnectionResponseV2 objStoreConnectionResponseV2 = response.getResult();

System.out.println(objStoreConnectionResponseV2);

Example request

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

Example request

obj_store_connection_response_v2 = watson_query_service.get_object_store_connections_v2().get_result()

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

Response

Response Body

objStoreConnectionResponseV2

Status Code

200
Success
400
Bad Request
401
Unauthorized
500
Internal Server Error

No Sample Response

This method does not specify any sample responses.

Grants user access to a specific virtualized table.

POST /dvapiserver/v2/privileges/users

(watsonQuery *WatsonQueryV1) GrantUserToVirtualTable(grantUserToVirtualTableOptions *GrantUserToVirtualTableOptions) (response *core.DetailedResponse, err error)

(watsonQuery *WatsonQueryV1) GrantUserToVirtualTableWithContext(ctx context.Context, grantUserToVirtualTableOptions *GrantUserToVirtualTableOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> grantUserToVirtualTable(GrantUserToVirtualTableOptions grantUserToVirtualTableOptions)

grant_user_to_virtual_table(self,
        table_name: str,
        table_schema: str,
        authid: str,
        **kwargs
    ) -> DetailedResponse

grantUserToVirtualTable(params)

Request

Instantiate the GrantUserToVirtualTableOptions struct and set the fields to provide parameter values for the GrantUserToVirtualTable method.

Use the GrantUserToVirtualTableOptions.Builder to create a GrantUserToVirtualTableOptions object that contains the parameter values for the grantUserToVirtualTable method.

Request Body

Required*

PostUserPrivilegesParameters

parameter

WithContext method only

GrantUserToVirtualTableOptions

The GrantUserToVirtualTable options.

GrantUserToVirtualTableOptions

The grantUserToVirtualTable options.

parameters

table_name
Required*
str
The name of the virtualized table.

Possible values: length ≥ 1
Examples:
value
_source
_lines
_html
table_schema
Required*
str
The schema of the virtualized table.

Possible values: length ≥ 1
Examples:
value
_source
_lines
_html
authid
Required*
str
The identifier of the authorization, if grant access to all users, the value is PUBLIC, othervise the value is the Watson Query username.

Possible values: length ≥ 1
Examples:
value
_source
_lines
_html

parameters

tableName
Required*
string
The name of the virtualized table.

Possible values: length ≥ 1
Examples:
value
_source
_lines
_html
tableSchema
Required*
string
The schema of the virtualized table.

Possible values: length ≥ 1
Examples:
value
_source
_lines
_html
authid
Required*
string
The identifier of the authorization, if grant access to all users, the value is PUBLIC, othervise the value is the Watson Query username.

Possible values: length ≥ 1
Examples:
value
_source
_lines
_html

Example request

curl -k -X POST -H "cache-control: no-cache" -H "content-type: application/json" -H "X-Db-Profile: $url_encoded_crn" -H "Authorization: Bearer $token" -d "{\"table_name\":\"EMPLOYEE\",\"table_schema\":\"dv_ibmid_060000s4y5\", \"authid\":\"PUBLIC\"}" "https://{region}.data-virtualization.cloud.ibm.com/dvapiserver/v2/privileges/users"

Example request

grantUserToVirtualTableOptions := watsonQueryService.NewGrantUserToVirtualTableOptions(
  "EMPLOYEE",
  "dv_ibmid_060000s4y5",
  "PUBLIC",
)

response, err := watsonQueryService.GrantUserToVirtualTable(grantUserToVirtualTableOptions)
if err != nil {
  panic(err)
}

Example request

GrantUserToVirtualTableOptions grantUserToVirtualTableOptions = new GrantUserToVirtualTableOptions.Builder()
  .tableName("EMPLOYEE")
  .tableSchema("dv_ibmid_060000s4y5")
  .authid("PUBLIC")
  .build();

Response<Void> response = watsonQueryService.grantUserToVirtualTable(grantUserToVirtualTableOptions).execute();

Example request

const params = {
  tableName: 'EMPLOYEE',
  tableSchema: 'dv_ibmid_060000s4y5',
  authid: 'PUBLIC',
};

try {
  await watsonQueryService.grantUserToVirtualTable(params);
} catch (err) {
  console.warn(err);
}

Example request

response = watson_query_service.grant_user_to_virtual_table(
  table_name='EMPLOYEE',
  table_schema='dv_ibmid_060000s4y5',
  authid='PUBLIC'
)

Response

Status Code

204
Success
400
Bad Request
401
Unauthorized
500
Internal Server Error

No Sample Response

This method does not specify any sample responses.

Revokes user access to the virtualized table.

DELETE /dvapiserver/v2/privileges/users/{authid}

(watsonQuery *WatsonQueryV1) RevokeUserFromObject(revokeUserFromObjectOptions *RevokeUserFromObjectOptions) (response *core.DetailedResponse, err error)

(watsonQuery *WatsonQueryV1) RevokeUserFromObjectWithContext(ctx context.Context, revokeUserFromObjectOptions *RevokeUserFromObjectOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> revokeUserFromObject(RevokeUserFromObjectOptions revokeUserFromObjectOptions)

revoke_user_from_object(self,
        authid: str,
        table_name: str,
        table_schema: str,
        **kwargs
    ) -> DetailedResponse

revokeUserFromObject(params)

Request

Instantiate the RevokeUserFromObjectOptions struct and set the fields to provide parameter values for the RevokeUserFromObject method.

Use the RevokeUserFromObjectOptions.Builder to create a RevokeUserFromObjectOptions object that contains the parameter values for the revokeUserFromObject method.

Path Parameters

authid
Required*
string
The Watson Query user name. If this value is Public, this API revokes access privilege from all Watson Query users.

Example: PUBLIC

Query Parameters

table_name
Required*
string
The virtualized table's name.

Example: EMPLOYEE
table_schema
Required*
string
The virtualized table's schema name.

Example: dv_ibmid_060000s4y5

parameter

WithContext method only

RevokeUserFromObjectOptions

The RevokeUserFromObject options.

RevokeUserFromObjectOptions

The revokeUserFromObject options.

parameters

authid
Required*
str
The Watson Query user name. If this value is Public, this API revokes access privilege from all Watson Query users.

Examples:
value
_source
_lines
_html
table_name
Required*
str
The virtualized table's name.

Examples:
value
_source
_lines
_html
table_schema
Required*
str
The virtualized table's schema name.

Examples:
value
_source
_lines
_html

parameters

authid
Required*
string
The Watson Query user name. If this value is Public, this API revokes access privilege from all Watson Query users.

Examples:
value
_source
_lines
_html
tableName
Required*
string
The virtualized table's name.

Examples:
value
_source
_lines
_html
tableSchema
Required*
string
The virtualized table's schema name.

Examples:
value
_source
_lines
_html

Example request

curl -k -X DELETE -H "cache-control: no-cache" -H "content-type: application/json" -H "X-Db-Profile: $url_encoded_crn" -H "Authorization: Bearer $token" "https://{region}.data-virtualization.cloud.ibm.com/dvapiserver/v2/privileges/users/PUBLIC?table_schema=dv_ibmid_060000s4y5&table_name=EMPLOYEE"

Example request

revokeUserFromObjectOptions := watsonQueryService.NewRevokeUserFromObjectOptions(
  "PUBLIC",
  "EMPLOYEE",
  "dv_ibmid_060000s4y5",
)

response, err := watsonQueryService.RevokeUserFromObject(revokeUserFromObjectOptions)
if err != nil {
  panic(err)
}

Example request

RevokeUserFromObjectOptions revokeUserFromObjectOptions = new RevokeUserFromObjectOptions.Builder()
  .authid("PUBLIC")
  .tableName("EMPLOYEE")
  .tableSchema("dv_ibmid_060000s4y5")
  .build();

Response<Void> response = watsonQueryService.revokeUserFromObject(revokeUserFromObjectOptions).execute();

Example request

const params = {
  authid: 'PUBLIC',
  tableName: 'EMPLOYEE',
  tableSchema: 'dv_ibmid_060000s4y5',
};

try {
  await watsonQueryService.revokeUserFromObject(params);
} catch (err) {
  console.warn(err);
}

Example request

response = watson_query_service.revoke_user_from_object(
  authid='PUBLIC',
  table_name='EMPLOYEE',
  table_schema='dv_ibmid_060000s4y5'
)

Response

Status Code

204
Success
400
Bad Request
401
Unauthorized
500
Internal Server Error

No Sample Response

This method does not specify any sample responses.

Grants a user role access to a specific virtualized table.

POST /dvapiserver/v2/privileges/roles

(watsonQuery *WatsonQueryV1) GrantRolesToVirtualizedTable(grantRolesToVirtualizedTableOptions *GrantRolesToVirtualizedTableOptions) (response *core.DetailedResponse, err error)

(watsonQuery *WatsonQueryV1) GrantRolesToVirtualizedTableWithContext(ctx context.Context, grantRolesToVirtualizedTableOptions *GrantRolesToVirtualizedTableOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> grantRolesToVirtualizedTable(GrantRolesToVirtualizedTableOptions grantRolesToVirtualizedTableOptions)

grant_roles_to_virtualized_table(self,
        table_name: str,
        table_schema: str,
        *,
        role_name: str = None,
        **kwargs
    ) -> DetailedResponse

grantRolesToVirtualizedTable(params)

Request

Instantiate the GrantRolesToVirtualizedTableOptions struct and set the fields to provide parameter values for the GrantRolesToVirtualizedTable method.

Use the GrantRolesToVirtualizedTableOptions.Builder to create a GrantRolesToVirtualizedTableOptions object that contains the parameter values for the grantRolesToVirtualizedTable method.

Request Body

Required*

PostRolePrivilegesParameters

parameter

WithContext method only

GrantRolesToVirtualizedTableOptions

The GrantRolesToVirtualizedTable options.

GrantRolesToVirtualizedTableOptions

The grantRolesToVirtualizedTable options.

parameters

table_name
Required*
str
The name of the virtualized table.

Possible values: length ≥ 1
Examples:
value
_source
_lines
_html
table_schema
Required*
str
The schema of the virtualized table.

Possible values: length ≥ 1
Examples:
value
_source
_lines
_html
role_name
str
The identifier of the authorization, if grant access to all users, the value is PUBLIC, othervise the value is the Watson Query username.

Possible values: length ≥ 1
Examples:
value
_source
_lines
_html

parameters

tableName
Required*
string
The name of the virtualized table.

Possible values: length ≥ 1
Examples:
value
_source
_lines
_html
tableSchema
Required*
string
The schema of the virtualized table.

Possible values: length ≥ 1
Examples:
value
_source
_lines
_html
roleName
string
The identifier of the authorization, if grant access to all users, the value is PUBLIC, othervise the value is the Watson Query username.

Possible values: length ≥ 1
Examples:
value
_source
_lines
_html

Example request

curl -k -X POST -H "cache-control: no-cache" -H "content-type: application/json" -H "X-Db-Profile: $url_encoded_crn" -H "Authorization: Bearer $token" -d "{\"table_name\":\"EMPLOYEE\",\"table_schema\":\"dv_ibmid_060000s4y5\",\"role_name\":\"DV_ENGINEER\"}" "https://{region}.data-virtualization.cloud.ibm.com/dvapiserver/v2/privileges/roles"

Example request

grantRolesToVirtualizedTableOptions := watsonQueryService.NewGrantRolesToVirtualizedTableOptions(
  "EMPLOYEE",
  "dv_ibmid_060000s4y5",
)

response, err := watsonQueryService.GrantRolesToVirtualizedTable(grantRolesToVirtualizedTableOptions)
if err != nil {
  panic(err)
}

Example request

GrantRolesToVirtualizedTableOptions grantRolesToVirtualizedTableOptions = new GrantRolesToVirtualizedTableOptions.Builder()
  .tableName("EMPLOYEE")
  .tableSchema("dv_ibmid_060000s4y5")
  .build();

Response<Void> response = watsonQueryService.grantRolesToVirtualizedTable(grantRolesToVirtualizedTableOptions).execute();

Example request

const params = {
  tableName: 'EMPLOYEE',
  tableSchema: 'dv_ibmid_060000s4y5',
};

try {
  await watsonQueryService.grantRolesToVirtualizedTable(params);
} catch (err) {
  console.warn(err);
}

Example request

response = watson_query_service.grant_roles_to_virtualized_table(
  table_name='EMPLOYEE',
  table_schema='dv_ibmid_060000s4y5'
)

Response

Status Code

204
Success
400
Bad Request
401
Unauthorized
500
Internal Server Error

No Sample Response

This method does not specify any sample responses.

Revokes roles for a virtualized table.

DELETE /dvapiserver/v2/privileges/roles/{role_name}

(watsonQuery *WatsonQueryV1) DvaasRevokeRoleFromTable(dvaasRevokeRoleFromTableOptions *DvaasRevokeRoleFromTableOptions) (response *core.DetailedResponse, err error)

(watsonQuery *WatsonQueryV1) DvaasRevokeRoleFromTableWithContext(ctx context.Context, dvaasRevokeRoleFromTableOptions *DvaasRevokeRoleFromTableOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> dvaasRevokeRoleFromTable(DvaasRevokeRoleFromTableOptions dvaasRevokeRoleFromTableOptions)

dvaas_revoke_role_from_table(self,
        role_name: str,
        table_name: str,
        table_schema: str,
        **kwargs
    ) -> DetailedResponse

dvaasRevokeRoleFromTable(params)

Request

Instantiate the DvaasRevokeRoleFromTableOptions struct and set the fields to provide parameter values for the DvaasRevokeRoleFromTable method.

Use the DvaasRevokeRoleFromTableOptions.Builder to create a DvaasRevokeRoleFromTableOptions object that contains the parameter values for the dvaasRevokeRoleFromTable method.

Path Parameters

role_name
Required*
string
The Watson Query role. Values can be DV_ADMIN, DV_ENGINEER, DV_STEWARD, or DV_WORKER, which correspond to MANAGER, ENGINEER, STEWARD, and USER roles in the user interface.

Example: DV_ENGINEER

Query Parameters

table_name
Required*
string
The virtualized table's name.

Example: EMPLOYEE
table_schema
Required*
string
The virtualized table's schema name.

Example: dv_ibmid_060000s4y5

parameter

WithContext method only

DvaasRevokeRoleFromTableOptions

The DvaasRevokeRoleFromTable options.

DvaasRevokeRoleFromTableOptions

The dvaasRevokeRoleFromTable options.

parameters

role_name
Required*
str
The Watson Query role. Values can be DV_ADMIN, DV_ENGINEER, DV_STEWARD, or DV_WORKER, which correspond to MANAGER, ENGINEER, STEWARD, and USER roles in the user interface.

Examples:
value
_source
_lines
_html
table_name
Required*
str
The virtualized table's name.

Examples:
value
_source
_lines
_html
table_schema
Required*
str
The virtualized table's schema name.

Examples:
value
_source
_lines
_html

parameters

roleName
Required*
string
The Watson Query role. Values can be DV_ADMIN, DV_ENGINEER, DV_STEWARD, or DV_WORKER, which correspond to MANAGER, ENGINEER, STEWARD, and USER roles in the user interface.

Examples:
value
_source
_lines
_html
tableName
Required*
string
The virtualized table's name.

Examples:
value
_source
_lines
_html
tableSchema
Required*
string
The virtualized table's schema name.

Examples:
value
_source
_lines
_html

Example request

curl -k -X DELETE -H "cache-control: no-cache" -H "content-type: application/json" -H "X-Db-Profile: $url_encoded_crn" -H "Authorization: Bearer $token" "https://{region}.data-virtualization.cloud.ibm.com/dvapiserver/v2/privileges/roles/DV_ENGINEER?table_schema=dv_ibmid_060000s4y5&table_name=EMPLOYEE"

Example request

dvaasRevokeRoleFromTableOptions := watsonQueryService.NewDvaasRevokeRoleFromTableOptions(
  "DV_ENGINEER",
  "EMPLOYEE",
  "dv_ibmid_060000s4y5",
)

response, err := watsonQueryService.DvaasRevokeRoleFromTable(dvaasRevokeRoleFromTableOptions)
if err != nil {
  panic(err)
}

Example request

DvaasRevokeRoleFromTableOptions dvaasRevokeRoleFromTableOptions = new DvaasRevokeRoleFromTableOptions.Builder()
  .roleName("DV_ENGINEER")
  .tableName("EMPLOYEE")
  .tableSchema("dv_ibmid_060000s4y5")
  .build();

Response<Void> response = watsonQueryService.dvaasRevokeRoleFromTable(dvaasRevokeRoleFromTableOptions).execute();

Example request

const params = {
  roleName: 'DV_ENGINEER',
  tableName: 'EMPLOYEE',
  tableSchema: 'dv_ibmid_060000s4y5',
};

try {
  await watsonQueryService.dvaasRevokeRoleFromTable(params);
} catch (err) {
  console.warn(err);
}

Example request

response = watson_query_service.dvaas_revoke_role_from_table(
  role_name='DV_ENGINEER',
  table_name='EMPLOYEE',
  table_schema='dv_ibmid_060000s4y5'
)

Response

Status Code

204
Success
400
Bad Request
401
Unauthorized
500
Internal Server Error

No Sample Response

This method does not specify any sample responses.

Retrieves the list of virtualized tables that have a specific role.

GET /dvapiserver/v2/privileges/tables

(watsonQuery *WatsonQueryV1) ListTablesForRole(listTablesForRoleOptions *ListTablesForRoleOptions) (result *TablesForRoleResponse, response *core.DetailedResponse, err error)

(watsonQuery *WatsonQueryV1) ListTablesForRoleWithContext(ctx context.Context, listTablesForRoleOptions *ListTablesForRoleOptions) (result *TablesForRoleResponse, response *core.DetailedResponse, err error)

ServiceCall<TablesForRoleResponse> listTablesForRole(ListTablesForRoleOptions listTablesForRoleOptions)

list_tables_for_role(self,
        rolename: str,
        **kwargs
    ) -> DetailedResponse

listTablesForRole(params)

Request

Instantiate the ListTablesForRoleOptions struct and set the fields to provide parameter values for the ListTablesForRole method.

Use the ListTablesForRoleOptions.Builder to create a ListTablesForRoleOptions object that contains the parameter values for the listTablesForRole method.

Query Parameters

rolename
Required*
string
Watson Query has four roles: MANAGER, STEWARD, ENGINEER and USER. The value of rolename should be one of these.

Example: MANAGER | STEWARD | ENGINEER | USER

parameter

WithContext method only

ListTablesForRoleOptions

The ListTablesForRole options.

ListTablesForRoleOptions

The listTablesForRole options.

parameters

rolename
Required*
str
Watson Query has four roles: MANAGER, STEWARD, ENGINEER and USER. The value of rolename should be one of these.

Examples:
value
_source
_lines
_html

parameters

rolename
Required*
string
Watson Query has four roles: MANAGER, STEWARD, ENGINEER and USER. The value of rolename should be one of these.

Examples:
value
_source
_lines
_html

Example request

curl -k -X GET -H "cache-control: no-cache" -H "content-type: application/json" -H "X-Db-Profile: $url_encoded_crn" -H "Authorization: Bearer $token" "https://{region}.data-virtualization.cloud.ibm.com/dvapiserver/v2/privileges/tables?rolename=DV_ENGINEER"

Example request

listTablesForRoleOptions := watsonQueryService.NewListTablesForRoleOptions(
  "MANAGER | STEWARD | ENGINEER | USER",
)

tablesForRoleResponse, response, err := watsonQueryService.ListTablesForRole(listTablesForRoleOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(tablesForRoleResponse, "", "  ")
fmt.Println(string(b))

Example request

ListTablesForRoleOptions listTablesForRoleOptions = new ListTablesForRoleOptions.Builder()
  .rolename("MANAGER | STEWARD | ENGINEER | USER")
  .build();

Response<TablesForRoleResponse> response = watsonQueryService.listTablesForRole(listTablesForRoleOptions).execute();
TablesForRoleResponse tablesForRoleResponse = response.getResult();

System.out.println(tablesForRoleResponse);

Example request

const params = {
  rolename: 'MANAGER | STEWARD | ENGINEER | USER',
};

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

Example request

tables_for_role_response = watson_query_service.list_tables_for_role(
  rolename='MANAGER | STEWARD | ENGINEER | USER'
).get_result()

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

Response

Response Body

TablesForRoleResponse

Status Code

200
Success
400
Bad Request
401
Unauthorized
500
Internal Server Error

Example responses

Status 200

{
  "objects": [
    {
      "table_name": "TEST_TABLE",
      "table_schema": "ADMIN"
    }
  ]
}

Success example

{
  "objects": [
    {
      "table_name": "TEST_TABLE",
      "table_schema": "ADMIN"
    }
  ]
}

Turns policy enforcement status on or off.

PUT /dvapiserver/v2/security/policy/status

(watsonQuery *WatsonQueryV1) TurnOnPolicyV2(turnOnPolicyV2Options *TurnOnPolicyV2Options) (result *TurnOnPolicyV2Response, response *core.DetailedResponse, err error)

(watsonQuery *WatsonQueryV1) TurnOnPolicyV2WithContext(ctx context.Context, turnOnPolicyV2Options *TurnOnPolicyV2Options) (result *TurnOnPolicyV2Response, response *core.DetailedResponse, err error)

ServiceCall<TurnOnPolicyV2Response> turnOnPolicyV2(TurnOnPolicyV2Options turnOnPolicyV2Options)

turn_on_policy_v2(self,
        status: str,
        **kwargs
    ) -> DetailedResponse

turnOnPolicyV2(params)

Request

Instantiate the TurnOnPolicyV2Options struct and set the fields to provide parameter values for the TurnOnPolicyV2 method.

Use the TurnOnPolicyV2Options.Builder to create a TurnOnPolicyV2Options object that contains the parameter values for the turnOnPolicyV2 method.

Query Parameters

status
Required*
string
Sets the status of the policy enforcement.

Example: enabled

parameter

WithContext method only

TurnOnPolicyV2Options

The TurnOnPolicyV2 options.

TurnOnPolicyV2Options

The turnOnPolicyV2 options.

parameters

status
Required*
str
Sets the status of the policy enforcement.

Examples:
value
_source
_lines
_html

parameters

status
Required*
string
Sets the status of the policy enforcement.

Examples:
value
_source
_lines
_html

Example request

curl -k -X PUT -H "cache-control: no-cache" -H "content-type: application/json" -H "X-Db-Profile: $url_encoded_crn" -H "Authorization: Bearer $token" "https://{region}.data-virtualization.cloud.ibm.com/dvapiserver/v2/security/policy/status?status=enabled"

Example request

turnOnPolicyV2Options := watsonQueryService.NewTurnOnPolicyV2Options(
  "enabled",
)

turnOnPolicyV2Response, response, err := watsonQueryService.TurnOnPolicyV2(turnOnPolicyV2Options)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(turnOnPolicyV2Response, "", "  ")
fmt.Println(string(b))

Example request

TurnOnPolicyV2Options turnOnPolicyV2Options = new TurnOnPolicyV2Options.Builder()
  .status("enabled")
  .build();

Response<TurnOnPolicyV2Response> response = watsonQueryService.turnOnPolicyV2(turnOnPolicyV2Options).execute();
TurnOnPolicyV2Response turnOnPolicyV2Response = response.getResult();

System.out.println(turnOnPolicyV2Response);

Example request

const params = {
  status: 'enabled',
};

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

Example request

turn_on_policy_v2_response = watson_query_service.turn_on_policy_v2(
  status='enabled'
).get_result()

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

Response

Response Body

TurnOnPolicyV2Response

Status Code

200
Success
401
Unauthorized
500
Internal Server Error

Example responses

{ "status": "enabled" }
{ "status": "enabled" }

Gets the policy enforcement status. The function returns enabled or disabled depending on the status.

GET /dvapiserver/v2/security/policy/status

(watsonQuery *WatsonQueryV1) CheckPolicyStatusV2(checkPolicyStatusV2Options *CheckPolicyStatusV2Options) (result *CheckPolicyStatusV2Response, response *core.DetailedResponse, err error)

(watsonQuery *WatsonQueryV1) CheckPolicyStatusV2WithContext(ctx context.Context, checkPolicyStatusV2Options *CheckPolicyStatusV2Options) (result *CheckPolicyStatusV2Response, response *core.DetailedResponse, err error)

ServiceCall<CheckPolicyStatusV2Response> checkPolicyStatusV2()

check_policy_status_v2(self,
        **kwargs
    ) -> DetailedResponse

checkPolicyStatusV2(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.

Example request

curl -k -X GET -H "cache-control: no-cache" -H "content-type: application/json" -H "X-Db-Profile: $url_encoded_crn" -H "Authorization: Bearer $token" "https://{region}.data-virtualization.cloud.ibm.com/dvapiserver/v2/security/policy/status"

Example request

checkPolicyStatusV2Options := watsonQueryService.NewCheckPolicyStatusV2Options()

checkPolicyStatusV2Response, response, err := watsonQueryService.CheckPolicyStatusV2(checkPolicyStatusV2Options)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(checkPolicyStatusV2Response, "", "  ")
fmt.Println(string(b))

Example request

CheckPolicyStatusV2Options checkPolicyStatusV2Options = new CheckPolicyStatusV2Options();

Response<CheckPolicyStatusV2Response> response = watsonQueryService.checkPolicyStatusV2(checkPolicyStatusV2Options).execute();
CheckPolicyStatusV2Response checkPolicyStatusV2Response = response.getResult();

System.out.println(checkPolicyStatusV2Response);

Example request

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

Example request

check_policy_status_v2_response = watson_query_service.check_policy_status_v2().get_result()

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

Response

Response Body

CheckPolicyStatusV2Response

Status Code

200
Success
401
Unauthorized
500
Internal Server Error

Example responses

{ "status": "enabled" }
{ "status": "enabled" }

Transforms a given data source table into a virtualized table.

POST /dvapiserver/v2/virtualization/tables

(watsonQuery *WatsonQueryV1) DvaasVirtualizeTable(dvaasVirtualizeTableOptions *DvaasVirtualizeTableOptions) (result *VirtualizeTableResponse, response *core.DetailedResponse, err error)

(watsonQuery *WatsonQueryV1) DvaasVirtualizeTableWithContext(ctx context.Context, dvaasVirtualizeTableOptions *DvaasVirtualizeTableOptions) (result *VirtualizeTableResponse, response *core.DetailedResponse, err error)

ServiceCall<VirtualizeTableResponse> dvaasVirtualizeTable(DvaasVirtualizeTableOptions dvaasVirtualizeTableOptions)

dvaas_virtualize_table(self,
        source_name: str,
        source_table_def: List['VirtualizeTableParameterSourceTableDefItem'],
        sources: List[str],
        virtual_name: str,
        virtual_schema: str,
        virtual_table_def: List['VirtualizeTableParameterVirtualTableDefItem'],
        *,
        is_included_columns: str = None,
        replace: bool = None,
        **kwargs
    ) -> DetailedResponse

dvaasVirtualizeTable(params)

Request

Instantiate the DvaasVirtualizeTableOptions struct and set the fields to provide parameter values for the DvaasVirtualizeTable method.

Use the DvaasVirtualizeTableOptions.Builder to create a DvaasVirtualizeTableOptions object that contains the parameter values for the dvaasVirtualizeTable method.

Request Body

Required*

VirtualizeTableParameter

Request body

parameter

WithContext method only

DvaasVirtualizeTableOptions

The DvaasVirtualizeTable options.

DvaasVirtualizeTableOptions

The dvaasVirtualizeTable options.

parameters

source_name
Required*
str
The name of the source table.

Examples:
value
_source
_lines
_html
source_table_def
Required*
sources
Required*
List[str]
virtual_name
Required*
str
The name of the table to be virtualized.

Examples:
value
_source
_lines
_html
virtual_schema
Required*
str
The schema of the table to be virtualized.

Examples:
value
_source
_lines
_html
virtual_table_def
Required*
is_included_columns
str
The columns that are included in the source table.

Examples:
value
_source
_lines
_html
replace
bool
Determines whether to replace columns in the virtualized table.

Examples:
value
_source
_lines
_html

parameters

sourceName
Required*
string
The name of the source table.

Examples:
value
_source
_lines
_html
sourceTableDef
Required*
sources
Required*
string[]
virtualName
Required*
string
The name of the table to be virtualized.

Examples:
value
_source
_lines
_html
virtualSchema
Required*
string
The schema of the table to be virtualized.

Examples:
value
_source
_lines
_html
virtualTableDef
Required*
isIncludedColumns
string
The columns that are included in the source table.

Examples:
value
_source
_lines
_html
replace
boolean
Determines whether to replace columns in the virtualized table.

Examples:
value
_source
_lines
_html

Example request

curl -k -X POST -H "cache-control: no-cache" -H "content-type: application/json" -H "X-Db-Profile: $url_encoded_crn" -H "Authorization: Bearer $token" -d "{\"is_included_columns\":\"Y, Y, N\",\"replace\":false,\"source_name\":\"Tab1\",\"source_table_def\":[{\"column_name\":\"Column1\",\"column_type\":\"INTEGER\"}],\"sources\":\"DB210001:Hjq1\",\"virtual_name\":\"Tab1\",\"virtual_schema\":\"dv_ibmid_060000s4y5\",\"virtual_table_def\":[{\"column_name\":\"Column1\",\"column_type\":\"INTEGER\"}]}" "https://{region}.data-virtualization.cloud.ibm.com/dvapiserver/v2/virtualization/tables"

Example request

virtualizeTableParameterSourceTableDefItemModel := &watsonqueryv1.VirtualizeTableParameterSourceTableDefItem{
  ColumnName: core.StringPtr("Column1"),
  ColumnType: core.StringPtr("INTEGER"),
}

virtualizeTableParameterVirtualTableDefItemModel := &watsonqueryv1.VirtualizeTableParameterVirtualTableDefItem{
  ColumnName: core.StringPtr("Column_1"),
  ColumnType: core.StringPtr("INTEGER"),
}

dvaasVirtualizeTableOptions := watsonQueryService.NewDvaasVirtualizeTableOptions(
  "Tab1",
  []watsonqueryv1.VirtualizeTableParameterSourceTableDefItem{*virtualizeTableParameterSourceTableDefItemModel},
  []string{`DB210001:"Hjq1"`},
  "Tab1",
  "dv_ibmid_060000s4y5",
  []watsonqueryv1.VirtualizeTableParameterVirtualTableDefItem{*virtualizeTableParameterVirtualTableDefItemModel},
)

virtualizeTableResponse, response, err := watsonQueryService.DvaasVirtualizeTable(dvaasVirtualizeTableOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(virtualizeTableResponse, "", "  ")
fmt.Println(string(b))

Example request

VirtualizeTableParameterSourceTableDefItem virtualizeTableParameterSourceTableDefItemModel = new VirtualizeTableParameterSourceTableDefItem.Builder()
  .columnName("Column1")
  .columnType("INTEGER")
  .build();
VirtualizeTableParameterVirtualTableDefItem virtualizeTableParameterVirtualTableDefItemModel = new VirtualizeTableParameterVirtualTableDefItem.Builder()
  .columnName("Column_1")
  .columnType("INTEGER")
  .build();
DvaasVirtualizeTableOptions dvaasVirtualizeTableOptions = new DvaasVirtualizeTableOptions.Builder()
  .sourceName("Tab1")
  .sourceTableDef(new java.util.ArrayList<VirtualizeTableParameterSourceTableDefItem>(java.util.Arrays.asList(virtualizeTableParameterSourceTableDefItemModel)))
  .sources(new java.util.ArrayList<String>(java.util.Arrays.asList("DB210001:\"Hjq1\"")))
  .virtualName("Tab1")
  .virtualSchema("dv_ibmid_060000s4y5")
  .virtualTableDef(new java.util.ArrayList<VirtualizeTableParameterVirtualTableDefItem>(java.util.Arrays.asList(virtualizeTableParameterVirtualTableDefItemModel)))
  .build();

Response<VirtualizeTableResponse> response = watsonQueryService.dvaasVirtualizeTable(dvaasVirtualizeTableOptions).execute();
VirtualizeTableResponse virtualizeTableResponse = response.getResult();

System.out.println(virtualizeTableResponse);

Example request

// Request models needed by this operation.

// VirtualizeTableParameterSourceTableDefItem
const virtualizeTableParameterSourceTableDefItemModel = {
  column_name: 'Column1',
  column_type: 'INTEGER',
};

// VirtualizeTableParameterVirtualTableDefItem
const virtualizeTableParameterVirtualTableDefItemModel = {
  column_name: 'Column_1',
  column_type: 'INTEGER',
};

const params = {
  sourceName: 'Tab1',
  sourceTableDef: [virtualizeTableParameterSourceTableDefItemModel],
  sources: ['DB210001:"Hjq1"'],
  virtualName: 'Tab1',
  virtualSchema: 'dv_ibmid_060000s4y5',
  virtualTableDef: [virtualizeTableParameterVirtualTableDefItemModel],
};

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

Example request

virtualize_table_parameter_source_table_def_item_model = {
  'column_name': 'Column1',
  'column_type': 'INTEGER',
}

virtualize_table_parameter_virtual_table_def_item_model = {
  'column_name': 'Column_1',
  'column_type': 'INTEGER',
}

virtualize_table_response = watson_query_service.dvaas_virtualize_table(
  source_name='Tab1',
  source_table_def=[virtualize_table_parameter_source_table_def_item_model],
  sources=['DB210001:"Hjq1"'],
  virtual_name='Tab1',
  virtual_schema='dv_ibmid_060000s4y5',
  virtual_table_def=[virtualize_table_parameter_virtual_table_def_item_model]
).get_result()

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

Response

Response Body

VirtualizeTableResponse

Status Code

201
Created
400
Bad Request
401
Unauthorized
500
Internal Server Error

No Sample Response

This method does not specify any sample responses.

Removes the virtual table. You must specify the schema and table name.

DELETE /dvapiserver/v2/virtualization/tables/{virtual_name}

(watsonQuery *WatsonQueryV1) DeleteTable(deleteTableOptions *DeleteTableOptions) (response *core.DetailedResponse, err error)

(watsonQuery *WatsonQueryV1) DeleteTableWithContext(ctx context.Context, deleteTableOptions *DeleteTableOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> deleteTable(DeleteTableOptions deleteTableOptions)

delete_table(self,
        virtual_schema: str,
        virtual_name: str,
        **kwargs
    ) -> DetailedResponse

deleteTable(params)

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.

Path Parameters

virtual_name
Required*
string
The name of virtualized table to be deleted.

Query Parameters

virtual_schema
Required*
string
The schema of virtualized table to be deleted.

parameter

WithContext method only

DeleteTableOptions

The DeleteTable options.

DeleteTableOptions

The deleteTable options.

parameters

virtual_schema
Required*
str
The schema of virtualized table to be deleted.
virtual_name
Required*
str
The name of virtualized table to be deleted.

parameters

virtualSchema
Required*
string
The schema of virtualized table to be deleted.
virtualName
Required*
string
The name of virtualized table to be deleted.

Example request

curl -k -X DELETE -H "cache-control: no-cache" -H "content-type: application/json" -H "X-Db-Profile: $url_encoded_crn" -H "Authorization: Bearer $token" "https://{region}.data-virtualization.cloud.ibm.com/dvapiserver/v2/virtualization/tables/EMPLOYEE?virtual_schema=dv_ibmid_060000s4y5"

Example request

deleteTableOptions := watsonQueryService.NewDeleteTableOptions(
  "testString",
  "testString",
)

response, err := watsonQueryService.DeleteTable(deleteTableOptions)
if err != nil {
  panic(err)
}

Example request

DeleteTableOptions deleteTableOptions = new DeleteTableOptions.Builder()
  .virtualSchema("testString")
  .virtualName("testString")
  .build();

Response<Void> response = watsonQueryService.deleteTable(deleteTableOptions).execute();

Example request

const params = {
  virtualSchema: 'testString',
  virtualName: 'testString',
};

try {
  await watsonQueryService.deleteTable(params);
} catch (err) {
  console.warn(err);
}

Example request

response = watson_query_service.delete_table(
  virtual_schema='testString',
  virtual_name='testString'
)

Response

Status Code

204
Success
400
Bad Request
500
Internal Server Error

No Sample Response

This method does not specify any sample responses.

Create a remote table for the ORC or Parquet file on a cloud object store (COS).

POST /dvapiserver/v2/virtualization/cloud_object_storages

(watsonQuery *WatsonQueryV1) VirtualizeCosV2(virtualizeCosV2Options *VirtualizeCosV2Options) (result *SuccessResponse, response *core.DetailedResponse, err error)

(watsonQuery *WatsonQueryV1) VirtualizeCosV2WithContext(ctx context.Context, virtualizeCosV2Options *VirtualizeCosV2Options) (result *SuccessResponse, response *core.DetailedResponse, err error)

ServiceCall<SuccessResponse> virtualizeCosV2(VirtualizeCosV2Options virtualizeCosV2Options)

virtualize_cos_v2(self,
        url: str,
        virtual_name: str,
        virtual_schema: str,
        virtual_table_def: List['VirtualizeCosV2RequestVirtualTableDefItem'],
        *,
        is_replace: bool = None,
        options: str = None,
        jwt_auth_user_payload: str = None,
        **kwargs
    ) -> DetailedResponse

virtualizeCosV2(params)

Request

Instantiate the VirtualizeCosV2Options struct and set the fields to provide parameter values for the VirtualizeCosV2 method.

Use the VirtualizeCosV2Options.Builder to create a VirtualizeCosV2Options object that contains the parameter values for the virtualizeCosV2 method.

Custom Headers

jwt-auth-user-payload
string
Supplied by proxy. Do NOT add your own value.

Request Body

Required*

object

parameter

WithContext method only

VirtualizeCosV2Options

The VirtualizeCosV2 options.

VirtualizeCosV2Options

The virtualizeCosV2 options.

parameters

url
Required*
str
The file path with bucket name.

Examples:
value
_source
_lines
_html
virtual_name
Required*
str
The virtual table name.
virtual_schema
Required*
str
The virtual table schema.
virtual_table_def
Required*
is_replace
bool
Whether to replace the existing table when creating the virtual table.

Default: false
options
str
The options used to virtualize file.

Examples:
value
_source
_lines
_html
jwt_auth_user_payload
str
Supplied by proxy. Do NOT add your own value.

parameters

url
Required*
string
The file path with bucket name.

Examples:
value
_source
_lines
_html
virtualName
Required*
string
The virtual table name.
virtualSchema
Required*
string
The virtual table schema.
virtualTableDef
Required*
isReplace
boolean
Whether to replace the existing table when creating the virtual table.

Default: false
options
string
The options used to virtualize file.

Examples:
value
_source
_lines
_html
jwtAuthUserPayload
string
Supplied by proxy. Do NOT add your own value.

Example request

curl -k -X POST -H "cache-control: no-cache" -H "content-type: application/json" -H "X-Db-Profile: $url_encoded_crn" -H "Authorization: Bearer $token" -d "{\"is_replace\":\"false\",\"options\":\"INCPARTS=true\",\"url\":\"s3a://testBucket/home/data.csv\",\"virtual_name\":\"employee\",\"virtual_schema\":\"db2inst1\",\"virtual_table_def\":[{\"column_name\":\"Column1\",\"column_type\":\"INTEGER\"}]}" "https://{region}.data-virtualization.cloud.ibm.com/dvapiserver/v2/virtualization/cloud_object_storages"

Example request

virtualizeCosV2RequestVirtualTableDefItemModel := &watsonqueryv1.VirtualizeCosV2RequestVirtualTableDefItem{
  ColumnName: core.StringPtr("Column_1"),
  ColumnType: core.StringPtr("INTEGER"),
}

virtualizeCosV2Options := watsonQueryService.NewVirtualizeCosV2Options(
  "s3a://testBucket/home/data.csv",
  "testString",
  "testString",
  []watsonqueryv1.VirtualizeCosV2RequestVirtualTableDefItem{*virtualizeCosV2RequestVirtualTableDefItemModel},
)

successResponse, response, err := watsonQueryService.VirtualizeCosV2(virtualizeCosV2Options)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(successResponse, "", "  ")
fmt.Println(string(b))

Example request

VirtualizeCosV2RequestVirtualTableDefItem virtualizeCosV2RequestVirtualTableDefItemModel = new VirtualizeCosV2RequestVirtualTableDefItem.Builder()
  .columnName("Column_1")
  .columnType("INTEGER")
  .build();
VirtualizeCosV2Options virtualizeCosV2Options = new VirtualizeCosV2Options.Builder()
  .url("s3a://testBucket/home/data.csv")
  .virtualName("testString")
  .virtualSchema("testString")
  .virtualTableDef(new java.util.ArrayList<VirtualizeCosV2RequestVirtualTableDefItem>(java.util.Arrays.asList(virtualizeCosV2RequestVirtualTableDefItemModel)))
  .build();

Response<SuccessResponse> response = watsonQueryService.virtualizeCosV2(virtualizeCosV2Options).execute();
SuccessResponse successResponse = response.getResult();

System.out.println(successResponse);

Example request

// Request models needed by this operation.

// VirtualizeCosV2RequestVirtualTableDefItem
const virtualizeCosV2RequestVirtualTableDefItemModel = {
  column_name: 'Column_1',
  column_type: 'INTEGER',
};

const params = {
  url: 's3a://testBucket/home/data.csv',
  virtualName: 'testString',
  virtualSchema: 'testString',
  virtualTableDef: [virtualizeCosV2RequestVirtualTableDefItemModel],
};

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

Example request

virtualize_cos_v2_request_virtual_table_def_item_model = {
  'column_name': 'Column_1',
  'column_type': 'INTEGER',
}

success_response = watson_query_service.virtualize_cos_v2(
  url='s3a://testBucket/home/data.csv',
  virtual_name='testString',
  virtual_schema='testString',
  virtual_table_def=[virtualize_cos_v2_request_virtual_table_def_item_model]
).get_result()

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

Response

Response Body

successResponse

Status Code

200
Success
400
Bad Request
401
Unauthorized
500
Internal Server Error

No Sample Response

This method does not specify any sample responses.

Removes the specified table. You must specify the schema, name, and type. You must use the Data Management Console (DMC) endpoint URL.

POST /dbapi/v4/dv/delete_virtualize_task

(watsonQuery *WatsonQueryV1) DeleteMultiTable(deleteMultiTableOptions *DeleteMultiTableOptions) (result *DeleteMultiTableResponse, response *core.DetailedResponse, err error)

(watsonQuery *WatsonQueryV1) DeleteMultiTableWithContext(ctx context.Context, deleteMultiTableOptions *DeleteMultiTableOptions) (result *DeleteMultiTableResponse, response *core.DetailedResponse, err error)

ServiceCall<DeleteMultiTableResponse> deleteMultiTable(DeleteMultiTableOptions deleteMultiTableOptions)

delete_multi_table(self,
        x_db_profile: str,
        delete_assets: List['DeleteMultiTableRequestDeleteAssetsItem'],
        **kwargs
    ) -> DetailedResponse

deleteMultiTable(params)

Request

Instantiate the DeleteMultiTableOptions struct and set the fields to provide parameter values for the DeleteMultiTable method.

Use the DeleteMultiTableOptions.Builder to create a DeleteMultiTableOptions object that contains the parameter values for the deleteMultiTable method.

Custom Headers

x-db-profile
Required*
string
The dv instance.

Example: crn%3Av1%3Astaging%3Apublic%3Adata-virtualization%3Aus-south%3Aa%2Fefab8d44eb3d4aa5b3e3ff020cf1d829%3A31852b74-8afa-4f90-a080-a5e899bf0a61%3A%3A

Request Body

Required*

object

parameter

WithContext method only

DeleteMultiTableOptions

The DeleteMultiTable options.

DeleteMultiTableOptions

The deleteMultiTable options.

parameters

x_db_profile
Required*
str
The dv instance.

Examples:
value
_source
_lines
_html
delete_assets
Required*

parameters

xDbProfile
Required*
string
The dv instance.

Examples:
value
_source
_lines
_html
deleteAssets
Required*

Example request

curl -k -X POST "https://{region}.data-virtualization.cloud.ibm.com/dbapi/v4/dv/delete_virtualize_task" -H "Authorization: Bearer $token" -H "x-db-profile: $url_encoded_crn" -H "Content-Type: application/json" -d "{\"delete_assets\": [{\"virtual_schema\": \"string\",\"virtual_name\": \"string\",\"type\": \"table\"}]}"

Example request

deleteMultiTableRequestDeleteAssetsItemModel := &watsonqueryv1.DeleteMultiTableRequestDeleteAssetsItem{
}

deleteMultiTableOptions := watsonQueryService.NewDeleteMultiTableOptions(
  "crn%3Av1%3Astaging%3Apublic%3Adata-virtualization%3Aus-south%3Aa%2Fefab8d44eb3d4aa5b3e3ff020cf1d829%3A31852b74-8afa-4f90-a080-a5e899bf0a61%3A%3A",
  []watsonqueryv1.DeleteMultiTableRequestDeleteAssetsItem{*deleteMultiTableRequestDeleteAssetsItemModel},
)

deleteMultiTableResponse, response, err := watsonQueryService.DeleteMultiTable(deleteMultiTableOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(deleteMultiTableResponse, "", "  ")
fmt.Println(string(b))

Example request

DeleteMultiTableRequestDeleteAssetsItem deleteMultiTableRequestDeleteAssetsItemModel = new DeleteMultiTableRequestDeleteAssetsItem.Builder()
  .build();
DeleteMultiTableOptions deleteMultiTableOptions = new DeleteMultiTableOptions.Builder()
  .xDbProfile("crn%3Av1%3Astaging%3Apublic%3Adata-virtualization%3Aus-south%3Aa%2Fefab8d44eb3d4aa5b3e3ff020cf1d829%3A31852b74-8afa-4f90-a080-a5e899bf0a61%3A%3A")
  .deleteAssets(new java.util.ArrayList<DeleteMultiTableRequestDeleteAssetsItem>(java.util.Arrays.asList(deleteMultiTableRequestDeleteAssetsItemModel)))
  .build();

Response<DeleteMultiTableResponse> response = watsonQueryService.deleteMultiTable(deleteMultiTableOptions).execute();
DeleteMultiTableResponse deleteMultiTableResponse = response.getResult();

System.out.println(deleteMultiTableResponse);

Example request

// Request models needed by this operation.

// DeleteMultiTableRequestDeleteAssetsItem
const deleteMultiTableRequestDeleteAssetsItemModel = {
};

const params = {
  xDbProfile: 'crn%3Av1%3Astaging%3Apublic%3Adata-virtualization%3Aus-south%3Aa%2Fefab8d44eb3d4aa5b3e3ff020cf1d829%3A31852b74-8afa-4f90-a080-a5e899bf0a61%3A%3A',
  deleteAssets: [deleteMultiTableRequestDeleteAssetsItemModel],
};

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

Example request

delete_multi_table_request_delete_assets_item_model = {
}

delete_multi_table_response = watson_query_service.delete_multi_table(
  x_db_profile='crn%3Av1%3Astaging%3Apublic%3Adata-virtualization%3Aus-south%3Aa%2Fefab8d44eb3d4aa5b3e3ff020cf1d829%3A31852b74-8afa-4f90-a080-a5e899bf0a61%3A%3A',
  delete_assets=[delete_multi_table_request_delete_assets_item_model]
).get_result()

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

Response

Response Body

object

DeleteMultiTableResponse

Status Code

200
Success
400
Bad Request
500
Internal Server Error

Example responses

Status 200

{
  "response": {
    "value": {
      "delete_assets_result": {
        "delete_sucess": [
          {
            "virtual_schema": "schema1",
            "virtual_name": "table1"
          }
        ],
        "delete_failed": [
          {
            "virtual_schema": "schema2",
            "virtual_name": "table2",
            "message": "SQLExecute: {42704} [IBM][CLI Driver][DB2/LINUXX8664] SQL0204N  \"schema2.table2\" is an undefined name.  SQLSTATE=42704\n"
          }
        ]
      }
    }
  }
}

Success example

{
  "response": {
    "value": {
      "delete_assets_result": {
        "delete_sucess": [
          {
            "virtual_schema": "schema1",
            "virtual_name": "table1"
          }
        ],
        "delete_failed": [
          {
            "virtual_schema": "schema2",
            "virtual_name": "table2",
            "message": "SQLExecute: {42704} [IBM][CLI Driver][DB2/LINUXX8664] SQL0204N  \"schema2.table2\" is an undefined name.  SQLSTATE=42704\n"
          }
        ]
      }
    }
  }
}

Gets the primary catalog ID from the DVSYS.INSTANCE_INFO table.

GET /dvapiserver/v2/catalog/primary

(watsonQuery *WatsonQueryV1) GetPrimaryCatalog(getPrimaryCatalogOptions *GetPrimaryCatalogOptions) (result *PrimaryCatalogInfo, response *core.DetailedResponse, err error)

(watsonQuery *WatsonQueryV1) GetPrimaryCatalogWithContext(ctx context.Context, getPrimaryCatalogOptions *GetPrimaryCatalogOptions) (result *PrimaryCatalogInfo, response *core.DetailedResponse, err error)

ServiceCall<PrimaryCatalogInfo> getPrimaryCatalog()

get_primary_catalog(self,
        **kwargs
    ) -> DetailedResponse

getPrimaryCatalog(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.

Example request

curl -k -X GET -H "cache-control: no-cache" -H "content-type: application/json" -H "X-Db-Profile: $url_encoded_crn" -H "Authorization: Bearer $token" "https://{region}.data-virtualization.cloud.ibm.com/dvapiserver/v2/catalog/primary"

Example request

getPrimaryCatalogOptions := watsonQueryService.NewGetPrimaryCatalogOptions()

primaryCatalogInfo, response, err := watsonQueryService.GetPrimaryCatalog(getPrimaryCatalogOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(primaryCatalogInfo, "", "  ")
fmt.Println(string(b))

Example request

GetPrimaryCatalogOptions getPrimaryCatalogOptions = new GetPrimaryCatalogOptions();

Response<PrimaryCatalogInfo> response = watsonQueryService.getPrimaryCatalog(getPrimaryCatalogOptions).execute();
PrimaryCatalogInfo primaryCatalogInfo = response.getResult();

System.out.println(primaryCatalogInfo);

Example request

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

Example request

primary_catalog_info = watson_query_service.get_primary_catalog().get_result()

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

Response

Response Body

primaryCatalogInfo

Status Code

200
Success
400
Bad Request
401
Unauthorized
500
Internal Server Error

No Sample Response

This method does not specify any sample responses.

Inserts primary catalog ID into the DVSYS.INSTANCE_INFO table.

POST /dvapiserver/v2/catalog/primary

(watsonQuery *WatsonQueryV1) PostPrimaryCatalog(postPrimaryCatalogOptions *PostPrimaryCatalogOptions) (result *PostPrimaryCatalog, response *core.DetailedResponse, err error)

(watsonQuery *WatsonQueryV1) PostPrimaryCatalogWithContext(ctx context.Context, postPrimaryCatalogOptions *PostPrimaryCatalogOptions) (result *PostPrimaryCatalog, response *core.DetailedResponse, err error)

ServiceCall<PostPrimaryCatalog> postPrimaryCatalog(PostPrimaryCatalogOptions postPrimaryCatalogOptions)

post_primary_catalog(self,
        guid: str,
        **kwargs
    ) -> DetailedResponse

postPrimaryCatalog(params)

Request

Instantiate the PostPrimaryCatalogOptions struct and set the fields to provide parameter values for the PostPrimaryCatalog method.

Use the PostPrimaryCatalogOptions.Builder to create a PostPrimaryCatalogOptions object that contains the parameter values for the postPrimaryCatalog method.

Request Body

Required*

primaryCatalog

Request body

parameter

WithContext method only

PostPrimaryCatalogOptions

The PostPrimaryCatalog options.

PostPrimaryCatalogOptions

The postPrimaryCatalog options.

parameters

guid
Required*
str
Examples:
value
_source
_lines
_html

parameters

guid
Required*
string
Examples:
value
_source
_lines
_html

Example request

curl -k -X POST -H "cache-control: no-cache" -H "content-type: application/json" -H "X-Db-Profile: $url_encoded_crn" -H "Authorization: Bearer $token" -d "{\"guid\": \"d77fc432-9b1a-4938-a2a5-9f37e08041f6\"}" "https://{region}.data-virtualization.cloud.ibm.com/dvapiserver/v2/catalog/primary"

Example request

postPrimaryCatalogOptions := watsonQueryService.NewPostPrimaryCatalogOptions(
  "d77fc432-9b1a-4938-a2a5-9f37e08041f6",
)

postPrimaryCatalog, response, err := watsonQueryService.PostPrimaryCatalog(postPrimaryCatalogOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(postPrimaryCatalog, "", "  ")
fmt.Println(string(b))

Example request

PostPrimaryCatalogOptions postPrimaryCatalogOptions = new PostPrimaryCatalogOptions.Builder()
  .guid("d77fc432-9b1a-4938-a2a5-9f37e08041f6")
  .build();

Response<PostPrimaryCatalog> response = watsonQueryService.postPrimaryCatalog(postPrimaryCatalogOptions).execute();
PostPrimaryCatalog postPrimaryCatalog = response.getResult();

System.out.println(postPrimaryCatalog);

Example request

const params = {
  guid: 'd77fc432-9b1a-4938-a2a5-9f37e08041f6',
};

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

Example request

post_primary_catalog = watson_query_service.post_primary_catalog(
  guid='d77fc432-9b1a-4938-a2a5-9f37e08041f6'
).get_result()

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

Response

Response Body

postPrimaryCatalog

Status Code

201
Created
400
Bad Request
401
Unauthorized
500
Internal Server Error

No Sample Response

This method does not specify any sample responses.

Deletes primary catalog item in the DVSYS.INSTANCE_INFO table.

DELETE /dvapiserver/v2/catalog/primary

(watsonQuery *WatsonQueryV1) DeletePrimaryCatalog(deletePrimaryCatalogOptions *DeletePrimaryCatalogOptions) (response *core.DetailedResponse, err error)

(watsonQuery *WatsonQueryV1) DeletePrimaryCatalogWithContext(ctx context.Context, deletePrimaryCatalogOptions *DeletePrimaryCatalogOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> deletePrimaryCatalog(DeletePrimaryCatalogOptions deletePrimaryCatalogOptions)

delete_primary_catalog(self,
        guid: str,
        **kwargs
    ) -> DetailedResponse

deletePrimaryCatalog(params)

Request

Instantiate the DeletePrimaryCatalogOptions struct and set the fields to provide parameter values for the DeletePrimaryCatalog method.

Use the DeletePrimaryCatalogOptions.Builder to create a DeletePrimaryCatalogOptions object that contains the parameter values for the deletePrimaryCatalog method.

Query Parameters

guid
Required*
string
The Watson Query user name. If the value is Public, this API revokes access privileges from all Watson Query users.

Example: d77fc432-9b1a-4938-a2a5-9f37e08041f6

parameter

WithContext method only

DeletePrimaryCatalogOptions

The DeletePrimaryCatalog options.

DeletePrimaryCatalogOptions

The deletePrimaryCatalog options.

parameters

guid
Required*
str
The Watson Query user name. If the value is Public, this API revokes access privileges from all Watson Query users.

Examples:
value
_source
_lines
_html

parameters

guid
Required*
string
The Watson Query user name. If the value is Public, this API revokes access privileges from all Watson Query users.

Examples:
value
_source
_lines
_html

Example request

curl -k -X DELETE -H "cache-control: no-cache" -H "content-type: application/json" -H "X-Db-Profile: $url_encoded_crn" -H "Authorization: Bearer $token" "https://{region}.data-virtualization.cloud.ibm.com/dvapiserver/v2/catalog/primary?guid=d77fc432-9b1a-4938-a2a5-9f37e08041f6"

Example request

deletePrimaryCatalogOptions := watsonQueryService.NewDeletePrimaryCatalogOptions(
  "d77fc432-9b1a-4938-a2a5-9f37e08041f6",
)

response, err := watsonQueryService.DeletePrimaryCatalog(deletePrimaryCatalogOptions)
if err != nil {
  panic(err)
}

Example request

DeletePrimaryCatalogOptions deletePrimaryCatalogOptions = new DeletePrimaryCatalogOptions.Builder()
  .guid("d77fc432-9b1a-4938-a2a5-9f37e08041f6")
  .build();

Response<Void> response = watsonQueryService.deletePrimaryCatalog(deletePrimaryCatalogOptions).execute();

Example request

const params = {
  guid: 'd77fc432-9b1a-4938-a2a5-9f37e08041f6',
};

try {
  await watsonQueryService.deletePrimaryCatalog(params);
} catch (err) {
  console.warn(err);
}

Example request

response = watson_query_service.delete_primary_catalog(
  guid='d77fc432-9b1a-4938-a2a5-9f37e08041f6'
)

Response

Status Code

204
Success
400
Bad Request
401
Unauthorized
500
Internal Server Error

No Sample Response

This method does not specify any sample responses.

Publishes virtual tables to a catalog.

POST /dvapiserver/v2/integration/catalog/publish

(watsonQuery *WatsonQueryV1) PublishAssets(publishAssetsOptions *PublishAssetsOptions) (result *CatalogPublishResponse, response *core.DetailedResponse, err error)

(watsonQuery *WatsonQueryV1) PublishAssetsWithContext(ctx context.Context, publishAssetsOptions *PublishAssetsOptions) (result *CatalogPublishResponse, response *core.DetailedResponse, err error)

ServiceCall<CatalogPublishResponse> publishAssets(PublishAssetsOptions publishAssetsOptions)

publish_assets(self,
        catalog_id: str,
        allow_duplicates: bool,
        assets: List['PostPrimaryCatalogParametersAssetsItem'],
        **kwargs
    ) -> DetailedResponse

publishAssets(params)

Introduction

Endpoint URLs

Authentication

Error handling

Related information

Methods

Get data source connections

Request

No Request Parameters

parameter

ctx

No Request Parameters

No Request Parameters

No Request Parameters

No Request Parameters

Response

Response Body

datasource_connections

node_name

node_description

agent_class

hostname

port

os_user

is_docker

dscount

data_sources

cid

dbname

connection_id

srchostname

srcport

srctype

usr

uri

status

connection_name

DatasourceConnectionsList

DatasourceConnections

NodeName

NodeDescription

AgentClass

Hostname

Port

OsUser

IsDocker

Dscount

DataSources

Cid

Dbname

ConnectionID

Srchostname

Srcport

Srctype

Usr

URI

Status

ConnectionName

DatasourceConnectionsList

datasourceConnections

nodeName

nodeDescription

agentClass

hostname

port

osUser

isDocker

dscount

dataSources

cid

dbname

connectionId

srchostname

srcport

srctype

usr

uri

status

connectionName

DatasourceConnectionsList