MaxCompute:CatalogAPI SDK User Guide

Method signature

Table createTable(Table table)

Request parameters

Response

Returns the created Table object.

Usage example

// Construct table
Table table = new Table();
table.setProjectId("my_project");
table.setSchemaName("default");
table.setTableName("my_table");
table.setDescription("This is an example table");
table.setType("TABLE");

// Set table schema
TableFieldSchema field = new TableFieldSchema();
field.setFieldName("id");
field.setTypeCategory("BIGINT");
field.setMode("REQUIRED");

TableFieldSchema nameField = new TableFieldSchema();
nameField.setFieldName("name");
nameField.setTypeCategory("STRING");
nameField.setMode("NULLABLE");

TableFieldSchema schema = new TableFieldSchema();
schema.setFields(Arrays.asList(field, nameField));
table.setTableSchema(schema);

// Create table
Table createdTable = client.createTable(table);
System.out.println("Created table: " + createdTable.getName());

Method signature

Table getTable(Table table)

Request parameters

Response

Returns a Table object.

Usage example

Table query = new Table();
query.setProjectId("my_project");
query.setSchemaName("default");
query.setTableName("my_table");

Table result = client.getTable(query);
System.out.println("Table type: " + result.getType());
System.out.println("Description: " + result.getDescription());

Method signature

Table updateTable(Table table)

Request parameters

Response

Returns the updated Table object.

Usage example

Table table = client.getTable(query);
table.setDescription("Updated description");

Table updated = client.updateTable(table);

Method signature

HttpResponse deleteTable(Table table)

Request parameters

Response

Returns an empty HttpResponse on success.

Usage example

HttpResponse response = client.deleteTable(table);
System.out.println("Status code: " + response.getStatusCode());

Method signature

ListTablesResponse listTables(String projectId, String schemaName, Integer pageSize, String pageToken)

Request parameters

Response

{
  "tables": [Table],
  "nextPageToken": "string"
}

Usage example

ListTablesResponse response = client.listTables("my_project", "default", 100, "");

// Iterate through all pages
while (response.getTables() != null && !response.getTables().isEmpty()) {
    for (Table t : response.getTables()) {
        System.out.println(t.getTableName());
    }
    
    if (response.getNextPageToken() == null || response.getNextPageToken().isEmpty()) {
        break;
    }
    response = client.listTables("my_project", "default", 100, response.getNextPageToken());
}

Method signature

Policy setTablePolicy(Table table, SetPolicyRequest request)

Request parameters

Response

Returns the updated Policy object.

Method signature

Policy getTablePolicy(Table table)

Request parameters

Response

Returns the Policy object of the table.

Method signature

DataToken getDataToken(Table table, Integer duration)

Request parameters

Response

{
  "version": "string",
  "type": "string",
  "value": "string",
  "expiration": "string"
}

DataToken field description

Method signature

ListPartitionsResponse listPartitions(
    String projectId, 
    String schemaName, 
    String tableName, 
    Integer pageSize, 
    String pageToken,
    String query,
    String view
)

Request parameters

Response

{
  "partitions": [Partition],
  "nextPageToken": "string"
}

Method signature

Connection createConnection(String namespace, Connection connection)

Request parameters

Response

Returns the created Connection object.

Usage example

// Construct Connection
Connection conn = new Connection();
conn.setConnectionName("my_oss_connection");
conn.setDescription("Connection for accessing OSS");
conn.setConnectionType("CLOUD_RESOURCE");

CloudResourceOptions options = new CloudResourceOptions();
options.setRamRoleArn("acs:ram::123456789:role/MaxComputeOSSRole");
conn.setCloudResource(options);

// Create connection
Connection created = client.createConnection("123456789", conn);

Method signature

ListConnectionsResponse listConnections(String namespace, Integer pageSize, String pageToken)

Request parameters

Response

{
  "connections": [Connection],
  "nextPageToken": "string"
}

Method signature

Connection getConnection(String namespace, String connectionName)

Method signature

Connection updateConnection(String namespace, String connectionName, Connection connection, String updateMask)

Request parameters

Response

Returns the updated Connection object.

Usage example

Connection conn = new Connection();
conn.setConnectionName("my_oss_connection");
conn.setDescription("Updated description");

Connection updated = client.updateConnection("123456789", "my_oss_connection", conn, "description");

Method signature

HttpResponse deleteConnection(String namespace, String connectionName)

Method signature

Policy setConnectionPolicy(String namespace, String connectionName, SetPolicyRequest request)

Method signature

Policy getConnectionPolicy(String namespace, String connectionName)

Method signature

Role createRole(String namespace, Role role)

Request parameters

Response

Returns the created Role object.

Usage example

Role role = new Role();
role.setRoleName("my_custom_role");
role.setDescription("Custom role");
role.setIncludedPermissions(Arrays.asList("odps:CreateTable", "odps:ListTable"));

Role created = client.createRole("123456789", role);

Method signature

ListRolesResponse listRoles(
    String namespace, 
    Integer pageSize, 
    String pageToken, 
    String view, 
    Boolean showDeleted
)

Request parameters

Response

{
  "roles": [Role],
  "nextPageToken": "string"
}

Method signature

Role getRole(String namespace, String roleName)

Request parameters

Method signature

Role updateRole(String namespace, String roleName, Role role, String updateMask)

Request parameters

Method signature

HttpResponse deleteRole(String namespace, String roleName)

Method signature

Policy setRolePolicy(String namespace, String roleName, SetPolicyRequest request)

Method signature

Policy getRolePolicy(String namespace, String roleName)

Method signature

Taxonomy createTaxonomy(String namespace, Taxonomy taxonomy)

Request parameters

Response

Returns the created Taxonomy object.

Usage example

Taxonomy taxonomy = new Taxonomy();
taxonomy.setTaxonomyName("sensitive_data");
taxonomy.setDescription("Sensitive data classification");
taxonomy.setActivatedPolicyTypes(Arrays.asList("FINE_GRAINED_ACCESS_CONTROL"));

Taxonomy created = client.createTaxonomy("123456789", taxonomy);

Method signature

ListTaxonomiesResponse listTaxonomies(String namespace, Integer pageSize, String pageToken)

Method signature

Taxonomy getTaxonomy(String namespace, String taxonomyId)

Method signature

Taxonomy updateTaxonomy(String namespace, String taxonomyId, Taxonomy taxonomy, String updateMask)

Request parameters

Method signature

HttpResponse deleteTaxonomy(String namespace, String taxonomyId)

Method signature

Policy setTaxonomyPolicy(String namespace, String taxonomyId, SetPolicyRequest request)

Method signature

Policy getTaxonomyPolicy(String namespace, String taxonomyId)

Method signature

PolicyTag createPolicyTag(String namespace, String taxonomyId, PolicyTag policyTag)

Request parameters

Response

Returns the created PolicyTag object.

Usage example

PolicyTag tag = new PolicyTag();
tag.setPolicyTagName("phone_number");
tag.setDescription("Phone number masking tag");

PolicyTag created = client.createPolicyTag("123456789", "taxonomy_id_123", tag);

Method signature

ListPolicyTagsResponse listPolicyTags(
    String namespace, 
    String taxonomyId, 
    Integer pageSize, 
    String pageToken
)

Method signature

PolicyTag getPolicyTag(String namespace, String taxonomyId, String policyTagId)

Method signature

PolicyTag updatePolicyTag(
    String namespace, 
    String taxonomyId, 
    String policyTagId, 
    PolicyTag policyTag, 
    String updateMask
)

Request parameters

Method signature

HttpResponse deletePolicyTag(String namespace, String taxonomyId, String policyTagId)

Method signature

Policy setPolicyTagPolicy(String namespace, String taxonomyId, String policyTagId, SetPolicyRequest request)

Method signature

Policy getPolicyTagPolicy(String namespace, String taxonomyId, String policyTagId)

Method signature

DataPolicy createDataPolicy(String namespace, DataPolicy dataPolicy)

Request parameters

Response

Returns the created DataPolicy object.

Usage example

// Construct masking rule
DataMaskingPolicy maskingPolicy = new DataMaskingPolicy();
maskingPolicy.setPredefinedExpression("STRING_MASKED_BA");

DataPolicy policy = new DataPolicy();
policy.setDataPolicyName("phone_masking");
policy.setPolicyTag("namespaces/123456789/taxonomies/tid_123/policyTags/ptid_456");
policy.setDataPolicyType("DATA_MASKING_POLICY");
policy.setDataMaskingPolicy(maskingPolicy);

DataPolicy created = client.createDataPolicy("123456789", policy);

Method signature

ListDataPoliciesResponse listDataPolicies(String namespace, Integer pageSize, String pageToken)

Method signature

DataPolicy getDataPolicy(String namespace, String dataPolicyName)

Method signature

HttpResponse deleteDataPolicy(String namespace, String dataPolicyName)

Method signature

Policy setDataPolicyPolicy(String namespace, String dataPolicyName, SetPolicyRequest request)

Method signature

Policy getDataPolicyPolicy(String namespace, String dataPolicyName)

Method signature

DataScan createDataScan(String namespace, DataScan dataScan)

Request parameters

Response

Returns the created DataScan object.

Usage example

// Construct crawling task
DataScanSource source = new DataScanSource();
source.setLocation("oss://my-bucket/my-path/");
source.setConnection("my_oss_connection");

DataScanTarget target = new DataScanTarget();
target.setProject("my_project");
target.setSchema("default");
target.setNamePrefix("auto_");

DataScanProperties properties = new DataScanProperties();
properties.setFormatFilter("AUTO");
properties.setScanMode("SAMPLE");
properties.setAutoCommit(true);

DataScan dataScan = new DataScan();
dataScan.setScanName("my_oss_scan");
dataScan.setType("TABLE_DISCOVERY");
dataScan.setDescription("Crawl OSS metadata");
dataScan.setSource(source);
dataScan.setTarget(target);
dataScan.setProperties(properties);
dataScan.setSchedulerMode("MANUAL");

DataScan created = client.createDataScan("123456789", dataScan);

Method signature

ListDataScansResponse listDataScans(String namespace, Integer pageSize, String pageToken)

Method signature

DataScan getDataScan(String namespace, String dataScanName)

Method signature

DataScan updateDataScan(String namespace, DataScan dataScan, String updateMask)

Method signature

HttpResponse deleteDataScan(String namespace, String dataScanName)

Method signature

HttpResponse triggerDataScan(String namespace, String dataScanName)

Usage example

HttpResponse response = client.triggerDataScan("123456789", "my_oss_scan");
System.out.println("Triggered: " + response.getStatusCode());

Method signature

ListDataScanJobsResponse listDataScanJobs(
    String namespace, 
    String dataScanName, 
    Integer pageSize, 
    String pageToken
)

Response

{
  "scanJobs": [ScanJob],
  "nextPageToken": "string"
}

ScanJob model

Method signature

Model createModel(String projectId, String schemaName, Model model)

Request parameters

Response

Returns the created Model object.

Usage example

Model model = new Model();
model.setModelName("my_llm_model");
model.setVersionName("v1");
model.setDefaultVersion("v1");
model.setDescription("My large language model");
model.setSourceType("IMPORT");
model.setModelType("LLM");
model.setPath("oss://my-bucket/models/my_llm/");
model.setTasks(Arrays.asList("text-generation", "chat"));

Model created = client.createModel("my_project", "default", model);

Method signature

ListModelsResponse listModels(
    String projectId, 
    String schemaName, 
    Integer pageSize, 
    String pageToken
)

Method signature

Model getModel(String projectId, String schemaName, String modelName, String versionName)

Request parameters

Method signature

Model updateModel(
    String projectId, 
    String schemaName, 
    String modelName, 
    Model model, 
    String updateMask, 
    String versionName
)

Method signature

HttpResponse deleteModel(String projectId, String schemaName, String modelName)

Method signature

Model createModelVersion(String projectId, String schemaName, String modelName, Model model)

Usage example

Model version = new Model();
version.setModelName("my_llm_model");
version.setVersionName("v2");
version.setVersionDescription("Updated model version");
version.setPath("oss://my-bucket/models/my_llm_v2/");
version.setTasks(Arrays.asList("text-generation", "chat"));

Model createdVersion = client.createModelVersion("my_project", "default", "my_llm_model", version);

Method signature

HttpResponse deleteModelVersion(
    String projectId, 
    String schemaName, 
    String modelName, 
    String versionName
)

Method signature

ListModelVersionsResponse listModelVersions(
    String projectId, 
    String schemaName, 
    String modelName, 
    Integer pageSize, 
    String pageToken
)

Method signature

Policy setModelPolicy(String projectId, String schemaName, String modelName, SetPolicyRequest request)

Method signature

Policy getModelPolicy(String projectId, String schemaName, String modelName)

Method signature

Project getProject(String projectId)

Usage example

Project project = client.getProject("my_project");
System.out.println("Project owner: " + project.getOwner());
System.out.println("Schema enabled: " + project.getSchemaEnabled());
System.out.println("Region: " + project.getRegion());

Method signature

Schema createSchema(String projectId, Schema schema)

Request parameters

Response

Returns the created Schema object.

Usage example

Schema schema = new Schema();
schema.setSchemaName("my_schema");
schema.setDescription("My custom schema");

Schema created = client.createSchema("my_project", schema);

Method signature

ListSchemasResponse listSchemas(String projectId, Integer pageSize, String pageToken)

Method signature

Schema getSchema(String projectId, String schemaName)

Method signature

Schema updateSchema(String projectId, String schemaName, String updateMask, Schema schema)

Request parameters

Method signature

HttpResponse deleteSchema(String projectId, String schemaName)

Method signature

Policy setSchemaPolicy(String projectId, String schemaName, SetPolicyRequest request)

Method signature

Policy getSchemaPolicy(String projectId, String schemaName)

Method signature

SearchResponse search(
    String namespaceId, 
    String query, 
    Integer pageSize, 
    String pageToken, 
    String orderBy
)

Request parameters

Query syntax

• List of query conditions:

  Query condition	Description
  name:foo	Match foo as a substring against the entity name
  description:bar	Match bar as a substring against the entity description
  type=TABLE	Required. Match entities of a specific type. Currently supports TABLE, RESOURCE, SCHEMA
  project=proj	Search entities under a single specified project only. The caller must have SearchProject permission for the project
  project=(proj1|proj2|proj3)	Search entities across multiple projects (up to 512). The caller must have SearchProject permission for all specified projects
  region=region_id	Search entities under projects in a specified region

  • project=proj and project=(proj1|proj2|proj3) cannot be used together

  • region=region_id cannot be used together with the project query condition

Sort order (orderBy)

Response

{
  "entries": [SearchResultEntry],
  "nextPageToken": "string"
}

Usage example

// Search all tables in a specified project
SearchResponse response = client.search(
    "123456789",                            // namespaceId
    "type=TABLE,project=my_project",        // query
    50,                                     // pageSize
    "",                                     // pageToken
    "last_modified_time desc"               // orderBy
);

if (response.getEntries() != null) {
    for (SearchResultEntry entry : response.getEntries()) {
        System.out.println("Name: " + entry.getDisplayName());
        System.out.println("Type: " + entry.getType());
        System.out.println("Path: " + entry.getName());
    }
}