Project-related API operations

Updated at:

Use the DataHub Java SDK to create, delete, update, list, and query projects.

Create a project

To create a project, provide the project name and description. The project name must be 3 to 32 characters in length, start with a letter, and contain only letters, digits, and underscores (_). Project names are not case-sensitive.

Parameters

Parameter

Type

Description

projectName

String

The project name.

comment

String

The project description.

Exceptions

Exception class

Error code

Description

DatahubClientException

-

Sample code

public static void createProject(String projectName,String projectComment) {
  try {
      datahubClient.createProject(projectName, projectComment);
      System.out.println("create project successful");
  } catch (DatahubClientException e) {
      System.out.println(e.getErrorMessage());
  }
}

Delete a project

Before you delete a project, make sure it does not contain any topics. Otherwise, a NoPermissionException exception is thrown.

Parameters

Parameter

Type

Description

projectName

String

The project name.

Exceptions

Exception class

Error code

Description

DatahubClientException

-

This is the base class for all exceptions.

NoPermissionException

NoPermission

OperationDenied

No permission. This is usually caused by incorrect RAM configuration or improper authorization for a RAM user.

Sample code

public static void deleteProject(String projectName) {
  try {
      datahubClient.deleteProject(projectName);
      System.out.println("delete project successful");
  } catch (DatahubClientException e) {
      System.out.println(e.getErrorMessage());
  }
}

Update a project

You can update the comment of a project.

Parameters

Parameter

Type

Description

projectName

String

The project name.

comment

String

The project description.

Exceptions

Exception class

Error code

Description

DatahubClientException

-

Sample code

public static void updateProject(String projectName,String newComment) {
    try {
        datahubClient.updateProject(projectName, newComment);
        System.out.println("update project successful");
    } catch (DatahubClientException e) {
        System.out.println("other error");
    }
}

List projects

You can list all project names in DataHub.

Exceptions

Exception class

Error code

Description

DatahubClientException

-

Sample code

public static void listProject() {
    try {
        ListProjectResult listProjectResult = datahubClient.listProject();
        if (listProjectResult.getProjectNames().size() > 0) {
            for (String pName : listProjectResult.getProjectNames()) {
                System.out.println(pName);
            }
        }
    } catch (DatahubClientException e) {
        System.out.println(e.getErrorMessage());
    }
}

Query a project

Parameters

Parameter

Type

Description

projectName

String

The project name.

Exceptions

Exception class

Error code

Description

DatahubClientException

-

Sample code

public static void getProject(String projectName) {
    try {
        GetProjectResult getProjectResult = datahubClient.getProject(projectName );
        System.out.println(getProjectResult.getCreateTime() + "\t"
                + getProjectResult.getLastModifyTime() + "\t"
                + getProjectResult.getComment());
    } catch (DatahubClientException e) {
        System.out.println(e.getErrorMessage());
    }
}