services

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

Overview

Name	services
Type	Resource
Id	google.metastore.services

Fields

Name	Datatype	Description
name	string	Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.
artifactGcsUri	string	Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
createTime	string	Output only. The time when the metastore service was created.
databaseType	string	Immutable. The database type that the Metastore service stores its data.
deletionProtection	boolean	Optional. Indicates if the dataproc metastore should be protected against accidental deletions.
encryptionConfig	object	Encryption settings for the service.
endpointUri	string	Output only. The URI of the endpoint used to access the metastore service.
hiveMetastoreConfig	object	Specifies configuration information specific to running Hive metastore software as the metastore service.
labels	object	User-defined labels for the metastore service.
maintenanceWindow	object	Maintenance window. This specifies when Dataproc Metastore may perform system maintenance operation to the service.
metadataIntegration	object	Specifies how metastore metadata should be integrated with external services.
metadataManagementActivity	object	The metadata management activities of the metastore service.
network	string	Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}.
networkConfig	object	Network configuration for the Dataproc Metastore service.
port	integer	The TCP port at which the metastore service is reached. Default: 9083.
releaseChannel	string	Immutable. The release channel of the service. If unspecified, defaults to STABLE.
scalingConfig	object	Represents the scaling configuration of a metastore service.
scheduledBackup	object	This specifies the configuration of scheduled backup.
state	string	Output only. The current state of the metastore service.
stateMessage	string	Output only. Additional information about the current state of the metastore service, if available.
telemetryConfig	object	Telemetry Configuration for the Dataproc Metastore service.
tier	string	The tier of the service.
uid	string	Output only. The globally unique resource identifier of the metastore service.
updateTime	string	Output only. The time when the metastore service was last updated.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, projectsId, servicesId	Gets the details of a single service.
list	SELECT	locationsId, projectsId	Lists services in a project and location.
create	INSERT	locationsId, projectsId	Creates a metastore service in a project and location.
delete	DELETE	locationsId, projectsId, servicesId	Deletes a single service.
patch	UPDATE	locationsId, projectsId, servicesId	Updates the parameters of a single service.
alter_location	EXEC	locationsId, projectsId, servicesId	Alter metadata resource location. The metadata resource can be a database, table, or partition. This functionality only updates the parent directory for the respective metadata resource and does not transfer any existing data to the new location.
alter_table_properties	EXEC	locationsId, projectsId, servicesId	Alter metadata table properties.
cancel_migration	EXEC	locationsId, projectsId, servicesId	Cancels the ongoing Managed Migration process.
complete_migration	EXEC	locationsId, projectsId, servicesId	Completes the managed migration process. The Dataproc Metastore service will switch to using its own backend database after successful migration.
export_metadata	EXEC	locationsId, projectsId, servicesId	Exports metadata from a service.
move_table_to_database	EXEC	locationsId, projectsId, servicesId	Move a table to another database.
query_metadata	EXEC	locationsId, projectsId, servicesId	Query Dataproc Metastore metadata.
restore	EXEC	locationsId, projectsId, servicesId	Restores a service from a backup.
start_migration	EXEC	locationsId, projectsId, servicesId	Starts the Managed Migration process.

SELECT examples

Lists services in a project and location.

SELECT
name,
artifactGcsUri,
createTime,
databaseType,
deletionProtection,
encryptionConfig,
endpointUri,
hiveMetastoreConfig,
labels,
maintenanceWindow,
metadataIntegration,
metadataManagementActivity,
network,
networkConfig,
port,
releaseChannel,
scalingConfig,
scheduledBackup,
state,
stateMessage,
telemetryConfig,
tier,
uid,
updateTime
FROM google.metastore.services
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new services resource.

All Properties

/*+ create */
INSERT INTO google.metastore.services (
locationsId,
projectsId,
hiveMetastoreConfig,
name,
labels,
network,
port,
tier,
metadataIntegration,
maintenanceWindow,
releaseChannel,
encryptionConfig,
networkConfig,
databaseType,
telemetryConfig,
scalingConfig,
scheduledBackup,
deletionProtection
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ hiveMetastoreConfig }}',
'{{ name }}',
'{{ labels }}',
'{{ network }}',
'{{ port }}',
'{{ tier }}',
'{{ metadataIntegration }}',
'{{ maintenanceWindow }}',
'{{ releaseChannel }}',
'{{ encryptionConfig }}',
'{{ networkConfig }}',
'{{ databaseType }}',
'{{ telemetryConfig }}',
'{{ scalingConfig }}',
'{{ scheduledBackup }}',
{{ deletionProtection }}
;

Manifest

- name: your_resource_model_name
  props:
    - name: hiveMetastoreConfig
      value:
        - name: version
          value: string
        - name: configOverrides
          value: object
        - name: kerberosConfig
          value:
            - name: keytab
              value:
                - name: cloudSecret
                  value: string
            - name: principal
              value: string
            - name: krb5ConfigGcsUri
              value: string
        - name: endpointProtocol
          value: string
        - name: auxiliaryVersions
          value: object
    - name: name
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: labels
      value: object
    - name: network
      value: string
    - name: endpointUri
      value: string
    - name: port
      value: integer
    - name: state
      value: string
    - name: stateMessage
      value: string
    - name: artifactGcsUri
      value: string
    - name: tier
      value: string
    - name: metadataIntegration
      value:
        - name: dataCatalogConfig
          value:
            - name: enabled
              value: boolean
    - name: maintenanceWindow
      value:
        - name: hourOfDay
          value: integer
        - name: dayOfWeek
          value: string
    - name: uid
      value: string
    - name: metadataManagementActivity
      value:
        - name: metadataExports
          value:
            - - name: destinationGcsUri
                value: string
              - name: startTime
                value: string
              - name: endTime
                value: string
              - name: state
                value: string
              - name: databaseDumpType
                value: string
        - name: restores
          value:
            - - name: startTime
                value: string
              - name: endTime
                value: string
              - name: state
                value: string
              - name: backup
                value: string
              - name: type
                value: string
              - name: details
                value: string
              - name: backupLocation
                value: string
    - name: releaseChannel
      value: string
    - name: encryptionConfig
      value:
        - name: kmsKey
          value: string
    - name: networkConfig
      value:
        - name: consumers
          value:
            - - name: subnetwork
                value: string
              - name: endpointUri
                value: string
              - name: endpointLocation
                value: string
    - name: databaseType
      value: string
    - name: telemetryConfig
      value:
        - name: logFormat
          value: string
    - name: scalingConfig
      value:
        - name: instanceSize
          value: string
        - name: scalingFactor
          value: number
        - name: autoscalingConfig
          value:
            - name: autoscalingFactor
              value: number
            - name: autoscalingEnabled
              value: boolean
            - name: limitConfig
              value:
                - name: maxScalingFactor
                  value: number
                - name: minScalingFactor
                  value: number
    - name: scheduledBackup
      value:
        - name: enabled
          value: boolean
        - name: cronSchedule
          value: string
        - name: timeZone
          value: string
        - name: nextScheduledTime
          value: string
        - name: backupLocation
          value: string
        - name: latestBackup
          value:
            - name: backupId
              value: string
            - name: startTime
              value: string
            - name: state
              value: string
            - name: duration
              value: string
    - name: deletionProtection
      value: boolean

UPDATE example

Updates a services resource.

/*+ update */
UPDATE google.metastore.services
SET 
hiveMetastoreConfig = '{{ hiveMetastoreConfig }}',
name = '{{ name }}',
labels = '{{ labels }}',
network = '{{ network }}',
port = '{{ port }}',
tier = '{{ tier }}',
metadataIntegration = '{{ metadataIntegration }}',
maintenanceWindow = '{{ maintenanceWindow }}',
releaseChannel = '{{ releaseChannel }}',
encryptionConfig = '{{ encryptionConfig }}',
networkConfig = '{{ networkConfig }}',
databaseType = '{{ databaseType }}',
telemetryConfig = '{{ telemetryConfig }}',
scalingConfig = '{{ scalingConfig }}',
scheduledBackup = '{{ scheduledBackup }}',
deletionProtection = true|false
WHERE 
locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND servicesId = '{{ servicesId }}';

DELETE example

Deletes the specified services resource.

/*+ delete */
DELETE FROM google.metastore.services
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND servicesId = '{{ servicesId }}';