Get

Retrieves information about the specified user.

TypeScript

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const GetUserRequest = cloudApi.mdb.clickhouse_user_service.GetUserRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.UserServiceClient);

  const result = await client.get(
    GetUserRequest.fromPartial({
      clusterId: "clusterId",
      userName: "userName",
    })
  );
  console.log(result);
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.mdb.clickhouse.v1.user_service_pb2 import GetUserRequest
from yandex.cloud.mdb.clickhouse.v1.user_service_pb2_grpc import UserServiceStub

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(UserServiceStub)
response = service.Get(GetUserRequest(cluster_id="clusterId", user_name="userName"))
print(response)

GetUserRequest

clusterId : string

ID of the cluster the user belongs to.

To get this ID, make a ClusterService.List request.

userName : string

Name of the user to return information about.

To get this name, make a UserService.List request.

User

An object that represents MySQL user.

See the documentation for details.

name : string

Name of the user.

clusterId : string

ID of the cluster the user belongs to.

permissions : Permission

Set of permissions granted to the user.

globalPermissions : GlobalPermission

Set of global permissions to grant to the user.

connectionLimits : ConnectionLimits

Set of user connection limits.

authenticationPlugin : AuthPlugin

User authentication plugin.

Permission

Privilege

• PRIVILEGE_UNSPECIFIED

• ALL_PRIVILEGES

  All privileges that can be made available to the user.

• ALTER

  Altering tables.

• ALTER_ROUTINE

  Altering stored routines and functions.

• CREATE

  Creating tables or indexes.

• CREATE_ROUTINE

  Creating stored routines.

• CREATE_TEMPORARY_TABLES

  Creating temporary tables.

• CREATE_VIEW

  Creating views.

• DELETE

  Deleting tables.

• DROP

  Removing tables or views.

• EVENT

  Creating, altering, dropping, or displaying events for the Event Scheduler.

• EXECUTE

  Executing stored routines.

• INDEX

  Creating and removing indexes.

• INSERT

  Inserting rows into the database.

• LOCK_TABLES

  Using LOCK TABLES statement for tables available with SELECT privilege.

• SELECT

  Selecting rows from tables. Some SELECT statements can be allowed without the SELECT privilege. All statements that read column values require the SELECT privilege. See MySQL documentation for details.

• SHOW_VIEW

  Using the SHOW CREATE VIEW statement. Also needed for views used with EXPLAIN.

• TRIGGER

  Creating, removing, executing, or displaying triggers for a table.

• UPDATE

  Updating rows in the database.

• REFERENCES

  Creation of a foreign key constraint for the parent table.

databaseName : string

Name of the database that the permission grants access to.

roles : Privilege

Roles granted to the user within the database.

See the documentation for details.

ConnectionLimits

maxQuestionsPerHour : google.protobuf.Int64Value

The maximum permitted number of user questions per hour.

maxUpdatesPerHour : google.protobuf.Int64Value

The maximum permitted number of user updates per hour.

maxConnectionsPerHour : google.protobuf.Int64Value

The maximum permitted number of simultaneous client connections per hour.

maxUserConnections : google.protobuf.Int64Value

The maximum number of simultaneous connections permitted to any given MySQL user account.

---