Class v1.SqlUsersServiceClient (0.4.0)
Cloud SQL users service. v1
Package
@google-cloud/sqlConstructors
(constructor)(opts, gaxInstance)
constructor(opts?:ClientOptions,gaxInstance?:typeofgax|typeofgax.fallback);Construct an instance of SqlUsersServiceClient.
| Parameters | |
|---|---|
| Name | Description |
opts | ClientOptions |
gaxInstance | typeofgax | typeoffallback: loaded instance of |
Properties
apiEndpoint
staticgetapiEndpoint():string;The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth:gax.GoogleAuth;descriptors
descriptors:Descriptors;innerApiCalls
innerApiCalls:{[name:string]:Function;};locationsClient
locationsClient:LocationsClient;port
staticgetport():number;The port for this API service.
scopes
staticgetscopes():string[];The scopes needed to make gRPC calls for every method defined in this service.
servicePath
staticgetservicePath():string;The DNS address for this API service.
sqlUsersServiceStub
sqlUsersServiceStub?:Promise<{[name:string]:Function;}>;warn
warn:(code:string,message:string,warnType?:string)=>void;Methods
close()
close():Promise<void>;Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
| Returns | |
|---|---|
| Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed. |
delete(request, options)
delete(request?:protos.google.cloud.sql.v1.ISqlUsersDeleteRequest,options?:CallOptions):Promise<[protos.google.cloud.sql.v1.IOperation,protos.google.cloud.sql.v1.ISqlUsersDeleteRequest|undefined,{}|undefined]>;Deletes a user from a Cloud SQL instance.
| Parameters | |
|---|---|
| Name | Description |
request | ISqlUsersDeleteRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.sql.v1.IOperation,protos.google.cloud.sql.v1.ISqlUsersDeleteRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Host of the user in the instance. */// const host = 'abc123'/** * Database instance ID. This does not include the project ID. */// const instance = 'abc123'/** * Name of the user in the instance. */// const name = 'abc123'/** * Project ID of the project that contains the instance. */// const project = 'my-project'// Imports the Sql libraryconst{SqlUsersServiceClient}=require('@google-cloud/sql').v1;// Instantiates a clientconstsqlClient=newSqlUsersServiceClient();asyncfunctioncallDelete(){// Construct requestconstrequest={};// Run requestconstresponse=awaitsqlClient.delete(request);console.log(response);}callDelete();delete(request, options, callback)
delete(request:protos.google.cloud.sql.v1.ISqlUsersDeleteRequest,options:CallOptions,callback:Callback<protos.google.cloud.sql.v1.IOperation,protos.google.cloud.sql.v1.ISqlUsersDeleteRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ISqlUsersDeleteRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.sql.v1.IOperation,protos.google.cloud.sql.v1.ISqlUsersDeleteRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
delete(request, callback)
delete(request:protos.google.cloud.sql.v1.ISqlUsersDeleteRequest,callback:Callback<protos.google.cloud.sql.v1.IOperation,protos.google.cloud.sql.v1.ISqlUsersDeleteRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ISqlUsersDeleteRequest |
callback | Callback<protos.google.cloud.sql.v1.IOperation,protos.google.cloud.sql.v1.ISqlUsersDeleteRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
get(request, options)
get(request?:protos.google.cloud.sql.v1.ISqlUsersGetRequest,options?:CallOptions):Promise<[protos.google.cloud.sql.v1.IUser,protos.google.cloud.sql.v1.ISqlUsersGetRequest|undefined,{}|undefined]>;Retrieves a resource containing information about a user.
| Parameters | |
|---|---|
| Name | Description |
request | ISqlUsersGetRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.sql.v1.IUser,protos.google.cloud.sql.v1.ISqlUsersGetRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Database instance ID. This does not include the project ID. */// const instance = 'abc123'/** * User of the instance. */// const name = 'abc123'/** * Project ID of the project that contains the instance. */// const project = 'my-project'/** * Host of a user of the instance. */// const host = 'abc123'// Imports the Sql libraryconst{SqlUsersServiceClient}=require('@google-cloud/sql').v1;// Instantiates a clientconstsqlClient=newSqlUsersServiceClient();asyncfunctioncallGet(){// Construct requestconstrequest={};// Run requestconstresponse=awaitsqlClient.get(request);console.log(response);}callGet();get(request, options, callback)
get(request:protos.google.cloud.sql.v1.ISqlUsersGetRequest,options:CallOptions,callback:Callback<protos.google.cloud.sql.v1.IUser,protos.google.cloud.sql.v1.ISqlUsersGetRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ISqlUsersGetRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.sql.v1.IUser,protos.google.cloud.sql.v1.ISqlUsersGetRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
get(request, callback)
get(request:protos.google.cloud.sql.v1.ISqlUsersGetRequest,callback:Callback<protos.google.cloud.sql.v1.IUser,protos.google.cloud.sql.v1.ISqlUsersGetRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ISqlUsersGetRequest |
callback | Callback<protos.google.cloud.sql.v1.IUser,protos.google.cloud.sql.v1.ISqlUsersGetRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getLocation(request, options, callback)
getLocation(request:LocationProtos.google.cloud.location.IGetLocationRequest,options?:gax.CallOptions|Callback<LocationProtos.google.cloud.location.ILocation,LocationProtos.google.cloud.location.IGetLocationRequest|null|undefined,{}|null|undefined>,callback?:Callback<LocationProtos.google.cloud.location.ILocation,LocationProtos.google.cloud.location.IGetLocationRequest|null|undefined,{}|null|undefined>):Promise<LocationProtos.google.cloud.location.ILocation>;Gets information about a location.
| Parameters | |
|---|---|
| Name | Description |
request | LocationProtos.google.cloud.location.IGetLocationRequestThe request object that will be sent. |
options | CallOptions |Callback<google.cloud.location.ILocation,google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>Call options. SeeCallOptions for more details. |
callback | Callback<google.cloud.location.ILocation,google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.location.ILocation> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see thedocumentation for more details and examples. |
const[response]=awaitclient.getLocation(request);getProjectId()
getProjectId():Promise<string>;| Returns | |
|---|---|
| Type | Description |
Promise<string> | |
getProjectId(callback)
getProjectId(callback:Callback<string,undefined,undefined>):void;| Parameter | |
|---|---|
| Name | Description |
callback | Callback<string, undefined, undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
initialize()
initialize():Promise<{[name:string]:Function;}>;Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
| Returns | |
|---|---|
| Type | Description |
Promise<{ [name: string]:Function; }> | {Promise} A promise that resolves to an authenticated service stub. |
insert(request, options)
insert(request?:protos.google.cloud.sql.v1.ISqlUsersInsertRequest,options?:CallOptions):Promise<[protos.google.cloud.sql.v1.IOperation,protos.google.cloud.sql.v1.ISqlUsersInsertRequest|undefined,{}|undefined]>;Creates a new user in a Cloud SQL instance.
| Parameters | |
|---|---|
| Name | Description |
request | ISqlUsersInsertRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.sql.v1.IOperation,protos.google.cloud.sql.v1.ISqlUsersInsertRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Database instance ID. This does not include the project ID. */// const instance = 'abc123'/** * Project ID of the project that contains the instance. */// const project = 'my-project'/** */// const body = {}// Imports the Sql libraryconst{SqlUsersServiceClient}=require('@google-cloud/sql').v1;// Instantiates a clientconstsqlClient=newSqlUsersServiceClient();asyncfunctioncallInsert(){// Construct requestconstrequest={};// Run requestconstresponse=awaitsqlClient.insert(request);console.log(response);}callInsert();insert(request, options, callback)
insert(request:protos.google.cloud.sql.v1.ISqlUsersInsertRequest,options:CallOptions,callback:Callback<protos.google.cloud.sql.v1.IOperation,protos.google.cloud.sql.v1.ISqlUsersInsertRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ISqlUsersInsertRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.sql.v1.IOperation,protos.google.cloud.sql.v1.ISqlUsersInsertRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
insert(request, callback)
insert(request:protos.google.cloud.sql.v1.ISqlUsersInsertRequest,callback:Callback<protos.google.cloud.sql.v1.IOperation,protos.google.cloud.sql.v1.ISqlUsersInsertRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ISqlUsersInsertRequest |
callback | Callback<protos.google.cloud.sql.v1.IOperation,protos.google.cloud.sql.v1.ISqlUsersInsertRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
list(request, options)
list(request?:protos.google.cloud.sql.v1.ISqlUsersListRequest,options?:CallOptions):Promise<[protos.google.cloud.sql.v1.IUsersListResponse,protos.google.cloud.sql.v1.ISqlUsersListRequest|undefined,{}|undefined]>;Lists users in the specified Cloud SQL instance.
| Parameters | |
|---|---|
| Name | Description |
request | ISqlUsersListRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.sql.v1.IUsersListResponse,protos.google.cloud.sql.v1.ISqlUsersListRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representingUsersListResponse. Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Database instance ID. This does not include the project ID. */// const instance = 'abc123'/** * Project ID of the project that contains the instance. */// const project = 'my-project'// Imports the Sql libraryconst{SqlUsersServiceClient}=require('@google-cloud/sql').v1;// Instantiates a clientconstsqlClient=newSqlUsersServiceClient();asyncfunctioncallList(){// Construct requestconstrequest={};// Run requestconstresponse=awaitsqlClient.list(request);console.log(response);}callList();list(request, options, callback)
list(request:protos.google.cloud.sql.v1.ISqlUsersListRequest,options:CallOptions,callback:Callback<protos.google.cloud.sql.v1.IUsersListResponse,protos.google.cloud.sql.v1.ISqlUsersListRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ISqlUsersListRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.sql.v1.IUsersListResponse,protos.google.cloud.sql.v1.ISqlUsersListRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
list(request, callback)
list(request:protos.google.cloud.sql.v1.ISqlUsersListRequest,callback:Callback<protos.google.cloud.sql.v1.IUsersListResponse,protos.google.cloud.sql.v1.ISqlUsersListRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ISqlUsersListRequest |
callback | Callback<protos.google.cloud.sql.v1.IUsersListResponse,protos.google.cloud.sql.v1.ISqlUsersListRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
listLocationsAsync(request, options)
listLocationsAsync(request:LocationProtos.google.cloud.location.IListLocationsRequest,options?:CallOptions):AsyncIterable<LocationProtos.google.cloud.location.ILocation>;Lists information about the supported locations for this service. Returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request | LocationProtos.google.cloud.location.IListLocationsRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<google.cloud.location.ILocation> | {Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples. |
constiterable=client.listLocationsAsync(request);forawait(constresponseofiterable){// process response}update(request, options)
update(request?:protos.google.cloud.sql.v1.ISqlUsersUpdateRequest,options?:CallOptions):Promise<[protos.google.cloud.sql.v1.IOperation,protos.google.cloud.sql.v1.ISqlUsersUpdateRequest|undefined,{}|undefined]>;Updates an existing user in a Cloud SQL instance.
| Parameters | |
|---|---|
| Name | Description |
request | ISqlUsersUpdateRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.sql.v1.IOperation,protos.google.cloud.sql.v1.ISqlUsersUpdateRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see thedocumentation for more details and examples. |
/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** * Optional. Host of the user in the instance. */// const host = 'abc123'/** * Database instance ID. This does not include the project ID. */// const instance = 'abc123'/** * Name of the user in the instance. */// const name = 'abc123'/** * Project ID of the project that contains the instance. */// const project = 'my-project'/** */// const body = {}// Imports the Sql libraryconst{SqlUsersServiceClient}=require('@google-cloud/sql').v1;// Instantiates a clientconstsqlClient=newSqlUsersServiceClient();asyncfunctioncallUpdate(){// Construct requestconstrequest={};// Run requestconstresponse=awaitsqlClient.update(request);console.log(response);}callUpdate();update(request, options, callback)
update(request:protos.google.cloud.sql.v1.ISqlUsersUpdateRequest,options:CallOptions,callback:Callback<protos.google.cloud.sql.v1.IOperation,protos.google.cloud.sql.v1.ISqlUsersUpdateRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ISqlUsersUpdateRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.sql.v1.IOperation,protos.google.cloud.sql.v1.ISqlUsersUpdateRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
update(request, callback)
update(request:protos.google.cloud.sql.v1.ISqlUsersUpdateRequest,callback:Callback<protos.google.cloud.sql.v1.IOperation,protos.google.cloud.sql.v1.ISqlUsersUpdateRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ISqlUsersUpdateRequest |
callback | Callback<protos.google.cloud.sql.v1.IOperation,protos.google.cloud.sql.v1.ISqlUsersUpdateRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-03 UTC.