app_profiles

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

Overview

Name	app_profiles
Type	Resource
Id	google.bigtableadmin.app_profiles

Fields

Name	Datatype	Description
name	string	The unique name of the app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9*.
description	string	Long form description of the use case for this AppProfile.
dataBoostIsolationReadOnly	object	Data Boost is a serverless compute capability that lets you run high-throughput read jobs and queries on your Bigtable data, without impacting the performance of the clusters that handle your application traffic. Data Boost supports read-only use cases with single-cluster routing.
etag	string	Strongly validated etag for optimistic concurrency control. Preserve the value returned from GetAppProfile when calling UpdateAppProfile to fail the request if there has been a modification in the mean time. The update_mask of the request need not include etag for this protection to apply. See Wikipedia and RFC 7232 for more details.
multiClusterRoutingUseAny	object	Read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability.
priority	string	This field has been deprecated in favor of standard_isolation.priority. If you set this field, standard_isolation.priority will be set instead. The priority of requests sent using this app profile.
singleClusterRouting	object	Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency but does not improve availability.
standardIsolation	object	Standard options for isolating this app profile's traffic from other use cases.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	appProfilesId, instancesId, projectsId	Gets information about an app profile.
list	SELECT	instancesId, projectsId	Lists information about app profiles in an instance.
create	INSERT	instancesId, projectsId	Creates an app profile within an instance.
delete	DELETE	appProfilesId, instancesId, projectsId	Deletes an app profile from an instance.
patch	UPDATE	appProfilesId, instancesId, projectsId	Updates an app profile within an instance.

SELECT examples

Lists information about app profiles in an instance.

SELECT
name,
description,
dataBoostIsolationReadOnly,
etag,
multiClusterRoutingUseAny,
priority,
singleClusterRouting,
standardIsolation
FROM google.bigtableadmin.app_profiles
WHERE instancesId = '{{ instancesId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO google.bigtableadmin.app_profiles (
instancesId,
projectsId,
name,
etag,
description,
multiClusterRoutingUseAny,
singleClusterRouting,
priority,
standardIsolation,
dataBoostIsolationReadOnly
)
SELECT 
'{{ instancesId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ etag }}',
'{{ description }}',
'{{ multiClusterRoutingUseAny }}',
'{{ singleClusterRouting }}',
'{{ priority }}',
'{{ standardIsolation }}',
'{{ dataBoostIsolationReadOnly }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: etag
      value: string
    - name: description
      value: string
    - name: multiClusterRoutingUseAny
      value:
        - name: clusterIds
          value:
            - string
        - name: rowAffinity
          value: []
    - name: singleClusterRouting
      value:
        - name: clusterId
          value: string
        - name: allowTransactionalWrites
          value: boolean
    - name: priority
      value: string
    - name: standardIsolation
      value:
        - name: priority
          value: string
    - name: dataBoostIsolationReadOnly
      value:
        - name: computeBillingOwner
          value: string

UPDATE example

Updates a app_profiles resource.

/*+ update */
UPDATE google.bigtableadmin.app_profiles
SET 
name = '{{ name }}',
etag = '{{ etag }}',
description = '{{ description }}',
multiClusterRoutingUseAny = '{{ multiClusterRoutingUseAny }}',
singleClusterRouting = '{{ singleClusterRouting }}',
priority = '{{ priority }}',
standardIsolation = '{{ standardIsolation }}',
dataBoostIsolationReadOnly = '{{ dataBoostIsolationReadOnly }}'
WHERE 
appProfilesId = '{{ appProfilesId }}'
AND instancesId = '{{ instancesId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified app_profiles resource.

/*+ delete */
DELETE FROM google.bigtableadmin.app_profiles
WHERE appProfilesId = '{{ appProfilesId }}'
AND instancesId = '{{ instancesId }}'
AND projectsId = '{{ projectsId }}';