users

Creates, updates, deletes, gets or lists a users resource.

Overview

Name	users
Type	Resource
Id	google.alloydb.users

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}.
databaseRoles	array	Optional. List of database roles this user has. The database role strings are subject to the PostgreSQL naming conventions.
keepExtraRoles	boolean	Input only. If the user already exists and it has additional roles, keep them granted.
password	string	Input only. Password for the user.
userType	string	Optional. Type of this user. (USER_TYPE_UNSPECIFIED, ALLOYDB_BUILT_IN, ALLOYDB_IAM_USER)

list

Name	Datatype	Description
name	string	Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}.
databaseRoles	array	Optional. List of database roles this user has. The database role strings are subject to the PostgreSQL naming conventions.
keepExtraRoles	boolean	Input only. If the user already exists and it has additional roles, keep them granted.
password	string	Input only. Password for the user.
userType	string	Optional. Type of this user. (USER_TYPE_UNSPECIFIED, ALLOYDB_BUILT_IN, ALLOYDB_IAM_USER)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, clustersId, usersId		Gets details of a single User.
list	select	projectsId, locationsId, clustersId	filter, orderBy, pageSize, pageToken	Lists Users in a given project and location.
create	insert	projectsId, locationsId, clustersId	requestId, userId, validateOnly	Creates a new User in a given project, location, and cluster.
patch	update	projectsId, locationsId, clustersId, usersId	allowMissing, requestId, updateMask, validateOnly	Updates the parameters of a single User.
delete	delete	projectsId, locationsId, clustersId, usersId	requestId, validateOnly	Deletes a single User.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
clustersId	string
locationsId	string
projectsId	string
usersId	string
allowMissing	boolean
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)
userId	string
validateOnly	boolean

SELECT examples

get

Gets details of a single User.

SELECT
name,
databaseRoles,
keepExtraRoles,
password,
userType
FROM google.alloydb.users
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND clustersId = '{{ clustersId }}' -- required
AND usersId = '{{ usersId }}' -- required
;

list

Lists Users in a given project and location.

SELECT
name,
databaseRoles,
keepExtraRoles,
password,
userType
FROM google.alloydb.users
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND clustersId = '{{ clustersId }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates a new User in a given project, location, and cluster.

INSERT INTO google.alloydb.users (
data__databaseRoles,
data__keepExtraRoles,
data__password,
data__userType,
projectsId,
locationsId,
clustersId,
requestId,
userId,
validateOnly
)
SELECT 
'{{ databaseRoles }}',
{{ keepExtraRoles }},
'{{ password }}',
'{{ userType }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ clustersId }}',
'{{ requestId }}',
'{{ userId }}',
'{{ validateOnly }}'
RETURNING
name,
databaseRoles,
keepExtraRoles,
password,
userType
;

Manifest

# Description fields are for documentation purposes
- name: users
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the users resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the users resource.
  - name: clustersId
    value: "{{ clustersId }}"
    description: Required parameter for the users resource.
  - name: databaseRoles
    value:
      - "{{ databaseRoles }}"
    description: |
      Optional. List of database roles this user has. The database role strings are subject to the PostgreSQL naming conventions.
  - name: keepExtraRoles
    value: {{ keepExtraRoles }}
    description: |
      Input only. If the user already exists and it has additional roles, keep them granted.
  - name: password
    value: "{{ password }}"
    description: |
      Input only. Password for the user.
  - name: userType
    value: "{{ userType }}"
    description: |
      Optional. Type of this user.
    valid_values: ['USER_TYPE_UNSPECIFIED', 'ALLOYDB_BUILT_IN', 'ALLOYDB_IAM_USER']
  - name: requestId
    value: "{{ requestId }}"
  - name: userId
    value: "{{ userId }}"
  - name: validateOnly
    value: {{ validateOnly }}

UPDATE examples

patch

Updates the parameters of a single User.

UPDATE google.alloydb.users
SET 
data__databaseRoles = '{{ databaseRoles }}',
data__keepExtraRoles = {{ keepExtraRoles }},
data__password = '{{ password }}',
data__userType = '{{ userType }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND clustersId = '{{ clustersId }}' --required
AND usersId = '{{ usersId }}' --required
AND allowMissing = {{ allowMissing}}
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
databaseRoles,
keepExtraRoles,
password,
userType;

DELETE examples

delete

Deletes a single User.

DELETE FROM google.alloydb.users
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND clustersId = '{{ clustersId }}' --required
AND usersId = '{{ usersId }}' --required
AND requestId = '{{ requestId }}'
AND validateOnly = '{{ validateOnly }}'
;