Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- spanner.projects.instanceConfigs.get
- spanner.projects.instanceConfigs.list
- spanner.projects.instances.create
- spanner.projects.instances.databases.create
- spanner.projects.instances.databases.dropDatabase
- spanner.projects.instances.databases.get
- spanner.projects.instances.databases.getDdl
- spanner.projects.instances.databases.getIamPolicy
- spanner.projects.instances.databases.list
- spanner.projects.instances.databases.operations.cancel
- spanner.projects.instances.databases.operations.delete
- spanner.projects.instances.databases.operations.get
- spanner.projects.instances.databases.operations.list
- spanner.projects.instances.databases.sessions.beginTransaction
- spanner.projects.instances.databases.sessions.commit
- spanner.projects.instances.databases.sessions.create
- spanner.projects.instances.databases.sessions.delete
- spanner.projects.instances.databases.sessions.executeBatchDml
- spanner.projects.instances.databases.sessions.executeSql
- spanner.projects.instances.databases.sessions.executeStreamingSql
- spanner.projects.instances.databases.sessions.get
- spanner.projects.instances.databases.sessions.list
- spanner.projects.instances.databases.sessions.partitionQuery
- spanner.projects.instances.databases.sessions.partitionRead
- spanner.projects.instances.databases.sessions.read
- spanner.projects.instances.databases.sessions.rollback
- spanner.projects.instances.databases.sessions.streamingRead
- spanner.projects.instances.databases.setIamPolicy
- spanner.projects.instances.databases.testIamPermissions
- spanner.projects.instances.databases.updateDdl
- spanner.projects.instances.delete
- spanner.projects.instances.get
- spanner.projects.instances.getIamPolicy
- spanner.projects.instances.list
- spanner.projects.instances.operations.cancel
- spanner.projects.instances.operations.delete
- spanner.projects.instances.operations.get
- spanner.projects.instances.operations.list
- spanner.projects.instances.patch
- spanner.projects.instances.setIamPolicy
- spanner.projects.instances.testIamPermissions
- Types
- ExecuteSQLRequestParams
- InstanceLabels
- CreateDatabaseMetadata
- TransactionOptions
- GetDatabaseDdlResponse
- Status
- CreateInstanceRequest
- ReadWrite
- RollbackRequest
- ListDatabasesResponse
- Expr
- ListOperationsResponse
- GetIAMPolicyRequest
- ChildLink
- BeginTransactionRequest
- PartitionOptions
- ResultSetStats
- Field
- TypeCode
- Write
- KeySet
- Statement
- PartitionQueryRequestParams
- ExecuteBatchDmlResponse
- Operation
- UpdateDatabaseDdlMetadata
- Empty
- Database
- PlanNode
- PlanNodeKind
- CreateSessionRequest
- ShortRepresentation
- ShortRepresentationSubqueries
- StatusDetailsItem
- PlanNodeMetadata
- PartitionedDml
- SetIAMPolicyRequest
- StatementParamTypes
- UpdateDatabaseDdlRequest
- Mutation
- PartitionReadRequest
- ExecuteSQLRequestQueryMode
- ExecuteSQLRequestParamTypes
- Transaction
- ListSessionsResponse
- ExecuteBatchDmlRequest
- StructType
- DatabaseState
- Xgafv
- CommitResponse
- Partition
- TestIAMPermissionsRequest
- PartitionQueryRequestParamTypes
- UpdateInstanceMetadata
- PlanNodeExecutionStats
- TestIAMPermissionsResponse
- PartialResultSet
- Policy
- CreateDatabaseRequest
- ExecuteSQLRequest
- CommitRequest
- Type
- CreateInstanceMetadata
- KeyRange
- OperationMetadata
- InstanceConfig
- ResultSet
- SessionLabels
- ListInstancesResponse
- ReadRequest
- InstanceState
- Session
- OperationResponse
- ReadOnly
- ResultSetMetadata
- Delete'
- UpdateInstanceRequest
- ResultSetStatsQueryStats
- StatementParams
- TransactionSelector
- ListInstanceConfigsResponse
- Binding
- PartitionResponse
- PartitionQueryRequest
- QueryPlan
- Instance
Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.
Synopsis
- spannerService :: ServiceConfig
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- spannerDataScope :: Proxy '["https://www.googleapis.com/auth/spanner.data"]
- spannerAdminScope :: Proxy '["https://www.googleapis.com/auth/spanner.admin"]
- type SpannerAPI = ProjectsInstancesOperationsListResource :<|> (ProjectsInstancesOperationsGetResource :<|> (ProjectsInstancesOperationsCancelResource :<|> (ProjectsInstancesOperationsDeleteResource :<|> (ProjectsInstancesDatabasesSessionsListResource :<|> (ProjectsInstancesDatabasesSessionsReadResource :<|> (ProjectsInstancesDatabasesSessionsExecuteStreamingSQLResource :<|> (ProjectsInstancesDatabasesSessionsPartitionQueryResource :<|> (ProjectsInstancesDatabasesSessionsBeginTransactionResource :<|> (ProjectsInstancesDatabasesSessionsGetResource :<|> (ProjectsInstancesDatabasesSessionsRollbackResource :<|> (ProjectsInstancesDatabasesSessionsCreateResource :<|> (ProjectsInstancesDatabasesSessionsPartitionReadResource :<|> (ProjectsInstancesDatabasesSessionsExecuteBatchDmlResource :<|> (ProjectsInstancesDatabasesSessionsStreamingReadResource :<|> (ProjectsInstancesDatabasesSessionsDeleteResource :<|> (ProjectsInstancesDatabasesSessionsExecuteSQLResource :<|> (ProjectsInstancesDatabasesSessionsCommitResource :<|> (ProjectsInstancesDatabasesOperationsListResource :<|> (ProjectsInstancesDatabasesOperationsGetResource :<|> (ProjectsInstancesDatabasesOperationsCancelResource :<|> (ProjectsInstancesDatabasesOperationsDeleteResource :<|> (ProjectsInstancesDatabasesDropDatabaseResource :<|> (ProjectsInstancesDatabasesListResource :<|> (ProjectsInstancesDatabasesUpdateDdlResource :<|> (ProjectsInstancesDatabasesGetIAMPolicyResource :<|> (ProjectsInstancesDatabasesGetResource :<|> (ProjectsInstancesDatabasesCreateResource :<|> (ProjectsInstancesDatabasesSetIAMPolicyResource :<|> (ProjectsInstancesDatabasesGetDdlResource :<|> (ProjectsInstancesDatabasesTestIAMPermissionsResource :<|> (ProjectsInstancesListResource :<|> (ProjectsInstancesGetIAMPolicyResource :<|> (ProjectsInstancesPatchResource :<|> (ProjectsInstancesGetResource :<|> (ProjectsInstancesCreateResource :<|> (ProjectsInstancesSetIAMPolicyResource :<|> (ProjectsInstancesTestIAMPermissionsResource :<|> (ProjectsInstancesDeleteResource :<|> (ProjectsInstanceConfigsListResource :<|> ProjectsInstanceConfigsGetResource)))))))))))))))))))))))))))))))))))))))
- module Network.Google.Resource.Spanner.Projects.InstanceConfigs.Get
- module Network.Google.Resource.Spanner.Projects.InstanceConfigs.List
- module Network.Google.Resource.Spanner.Projects.Instances.Create
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.Create
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.DropDatabase
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.Get
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.GetDdl
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.GetIAMPolicy
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.List
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.Operations.Cancel
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.Operations.Delete
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.Operations.Get
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.Operations.List
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.BeginTransaction
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.Commit
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.Create
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.Delete
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.ExecuteBatchDml
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.ExecuteSQL
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.ExecuteStreamingSQL
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.Get
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.List
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.PartitionQuery
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.PartitionRead
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.Read
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.Rollback
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.StreamingRead
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.SetIAMPolicy
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.TestIAMPermissions
- module Network.Google.Resource.Spanner.Projects.Instances.Databases.UpdateDdl
- module Network.Google.Resource.Spanner.Projects.Instances.Delete
- module Network.Google.Resource.Spanner.Projects.Instances.Get
- module Network.Google.Resource.Spanner.Projects.Instances.GetIAMPolicy
- module Network.Google.Resource.Spanner.Projects.Instances.List
- module Network.Google.Resource.Spanner.Projects.Instances.Operations.Cancel
- module Network.Google.Resource.Spanner.Projects.Instances.Operations.Delete
- module Network.Google.Resource.Spanner.Projects.Instances.Operations.Get
- module Network.Google.Resource.Spanner.Projects.Instances.Operations.List
- module Network.Google.Resource.Spanner.Projects.Instances.Patch
- module Network.Google.Resource.Spanner.Projects.Instances.SetIAMPolicy
- module Network.Google.Resource.Spanner.Projects.Instances.TestIAMPermissions
- data ExecuteSQLRequestParams
- executeSQLRequestParams :: HashMap Text JSONValue -> ExecuteSQLRequestParams
- esqlrpAddtional :: Lens' ExecuteSQLRequestParams (HashMap Text JSONValue)
- data InstanceLabels
- instanceLabels :: HashMap Text Text -> InstanceLabels
- ilAddtional :: Lens' InstanceLabels (HashMap Text Text)
- data CreateDatabaseMetadata
- createDatabaseMetadata :: CreateDatabaseMetadata
- cdmDatabase :: Lens' CreateDatabaseMetadata (Maybe Text)
- data TransactionOptions
- transactionOptions :: TransactionOptions
- toReadWrite :: Lens' TransactionOptions (Maybe ReadWrite)
- toPartitionedDml :: Lens' TransactionOptions (Maybe PartitionedDml)
- toReadOnly :: Lens' TransactionOptions (Maybe ReadOnly)
- data GetDatabaseDdlResponse
- getDatabaseDdlResponse :: GetDatabaseDdlResponse
- gddrStatements :: Lens' GetDatabaseDdlResponse [Text]
- data Status
- status :: Status
- sDetails :: Lens' Status [StatusDetailsItem]
- sCode :: Lens' Status (Maybe Int32)
- sMessage :: Lens' Status (Maybe Text)
- data CreateInstanceRequest
- createInstanceRequest :: CreateInstanceRequest
- cirInstanceId :: Lens' CreateInstanceRequest (Maybe Text)
- cirInstance :: Lens' CreateInstanceRequest (Maybe Instance)
- data ReadWrite
- readWrite :: ReadWrite
- data RollbackRequest
- rollbackRequest :: RollbackRequest
- rrTransactionId :: Lens' RollbackRequest (Maybe ByteString)
- data ListDatabasesResponse
- listDatabasesResponse :: ListDatabasesResponse
- ldrNextPageToken :: Lens' ListDatabasesResponse (Maybe Text)
- ldrDatabases :: Lens' ListDatabasesResponse [Database]
- data Expr
- expr :: Expr
- eLocation :: Lens' Expr (Maybe Text)
- eExpression :: Lens' Expr (Maybe Text)
- eTitle :: Lens' Expr (Maybe Text)
- eDescription :: Lens' Expr (Maybe Text)
- data ListOperationsResponse
- listOperationsResponse :: ListOperationsResponse
- lorNextPageToken :: Lens' ListOperationsResponse (Maybe Text)
- lorOperations :: Lens' ListOperationsResponse [Operation]
- data GetIAMPolicyRequest
- getIAMPolicyRequest :: GetIAMPolicyRequest
- data ChildLink
- childLink :: ChildLink
- clChildIndex :: Lens' ChildLink (Maybe Int32)
- clVariable :: Lens' ChildLink (Maybe Text)
- clType :: Lens' ChildLink (Maybe Text)
- data BeginTransactionRequest
- beginTransactionRequest :: BeginTransactionRequest
- btrOptions :: Lens' BeginTransactionRequest (Maybe TransactionOptions)
- data PartitionOptions
- partitionOptions :: PartitionOptions
- poMaxPartitions :: Lens' PartitionOptions (Maybe Int64)
- poPartitionSizeBytes :: Lens' PartitionOptions (Maybe Int64)
- data ResultSetStats
- resultSetStats :: ResultSetStats
- rssRowCountExact :: Lens' ResultSetStats (Maybe Int64)
- rssRowCountLowerBound :: Lens' ResultSetStats (Maybe Int64)
- rssQueryStats :: Lens' ResultSetStats (Maybe ResultSetStatsQueryStats)
- rssQueryPlan :: Lens' ResultSetStats (Maybe QueryPlan)
- data Field
- field :: Field
- fName :: Lens' Field (Maybe Text)
- fType :: Lens' Field (Maybe Type)
- data TypeCode
- data Write
- write :: Write
- wValues :: Lens' Write [[JSONValue]]
- wColumns :: Lens' Write [Text]
- wTable :: Lens' Write (Maybe Text)
- data KeySet
- keySet :: KeySet
- ksAll :: Lens' KeySet (Maybe Bool)
- ksRanges :: Lens' KeySet [KeyRange]
- ksKeys :: Lens' KeySet [[JSONValue]]
- data Statement
- statement :: Statement
- sParamTypes :: Lens' Statement (Maybe StatementParamTypes)
- sParams :: Lens' Statement (Maybe StatementParams)
- sSQL :: Lens' Statement (Maybe Text)
- data PartitionQueryRequestParams
- partitionQueryRequestParams :: HashMap Text JSONValue -> PartitionQueryRequestParams
- pqrpAddtional :: Lens' PartitionQueryRequestParams (HashMap Text JSONValue)
- data ExecuteBatchDmlResponse
- executeBatchDmlResponse :: ExecuteBatchDmlResponse
- ebdrStatus :: Lens' ExecuteBatchDmlResponse (Maybe Status)
- ebdrResultSets :: Lens' ExecuteBatchDmlResponse [ResultSet]
- data Operation
- operation :: Operation
- oDone :: Lens' Operation (Maybe Bool)
- oError :: Lens' Operation (Maybe Status)
- oResponse :: Lens' Operation (Maybe OperationResponse)
- oName :: Lens' Operation (Maybe Text)
- oMetadata :: Lens' Operation (Maybe OperationMetadata)
- data UpdateDatabaseDdlMetadata
- updateDatabaseDdlMetadata :: UpdateDatabaseDdlMetadata
- uddmCommitTimestamps :: Lens' UpdateDatabaseDdlMetadata [UTCTime]
- uddmDatabase :: Lens' UpdateDatabaseDdlMetadata (Maybe Text)
- uddmStatements :: Lens' UpdateDatabaseDdlMetadata [Text]
- data Empty
- empty :: Empty
- data Database
- database :: Database
- dState :: Lens' Database (Maybe DatabaseState)
- dName :: Lens' Database (Maybe Text)
- data PlanNode
- planNode :: PlanNode
- pnKind :: Lens' PlanNode (Maybe PlanNodeKind)
- pnShortRepresentation :: Lens' PlanNode (Maybe ShortRepresentation)
- pnMetadata :: Lens' PlanNode (Maybe PlanNodeMetadata)
- pnDisplayName :: Lens' PlanNode (Maybe Text)
- pnExecutionStats :: Lens' PlanNode (Maybe PlanNodeExecutionStats)
- pnIndex :: Lens' PlanNode (Maybe Int32)
- pnChildLinks :: Lens' PlanNode [ChildLink]
- data PlanNodeKind
- data CreateSessionRequest
- createSessionRequest :: CreateSessionRequest
- csrSession :: Lens' CreateSessionRequest (Maybe Session)
- data ShortRepresentation
- shortRepresentation :: ShortRepresentation
- srSubqueries :: Lens' ShortRepresentation (Maybe ShortRepresentationSubqueries)
- srDescription :: Lens' ShortRepresentation (Maybe Text)
- data ShortRepresentationSubqueries
- shortRepresentationSubqueries :: HashMap Text Int32 -> ShortRepresentationSubqueries
- srsAddtional :: Lens' ShortRepresentationSubqueries (HashMap Text Int32)
- data StatusDetailsItem
- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
- sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
- data PlanNodeMetadata
- planNodeMetadata :: HashMap Text JSONValue -> PlanNodeMetadata
- pnmAddtional :: Lens' PlanNodeMetadata (HashMap Text JSONValue)
- data PartitionedDml
- partitionedDml :: PartitionedDml
- data SetIAMPolicyRequest
- setIAMPolicyRequest :: SetIAMPolicyRequest
- siprPolicy :: Lens' SetIAMPolicyRequest (Maybe Policy)
- data StatementParamTypes
- statementParamTypes :: HashMap Text Type -> StatementParamTypes
- sptAddtional :: Lens' StatementParamTypes (HashMap Text Type)
- data UpdateDatabaseDdlRequest
- updateDatabaseDdlRequest :: UpdateDatabaseDdlRequest
- uddrOperationId :: Lens' UpdateDatabaseDdlRequest (Maybe Text)
- uddrStatements :: Lens' UpdateDatabaseDdlRequest [Text]
- data Mutation
- mutation :: Mutation
- mReplace :: Lens' Mutation (Maybe Write)
- mInsert :: Lens' Mutation (Maybe Write)
- mInsertOrUpdate :: Lens' Mutation (Maybe Write)
- mDelete :: Lens' Mutation (Maybe Delete')
- mUpdate :: Lens' Mutation (Maybe Write)
- data PartitionReadRequest
- partitionReadRequest :: PartitionReadRequest
- prrPartitionOptions :: Lens' PartitionReadRequest (Maybe PartitionOptions)
- prrKeySet :: Lens' PartitionReadRequest (Maybe KeySet)
- prrTransaction :: Lens' PartitionReadRequest (Maybe TransactionSelector)
- prrColumns :: Lens' PartitionReadRequest [Text]
- prrIndex :: Lens' PartitionReadRequest (Maybe Text)
- prrTable :: Lens' PartitionReadRequest (Maybe Text)
- data ExecuteSQLRequestQueryMode
- data ExecuteSQLRequestParamTypes
- executeSQLRequestParamTypes :: HashMap Text Type -> ExecuteSQLRequestParamTypes
- esqlrptAddtional :: Lens' ExecuteSQLRequestParamTypes (HashMap Text Type)
- data Transaction
- transaction :: Transaction
- tReadTimestamp :: Lens' Transaction (Maybe UTCTime)
- tId :: Lens' Transaction (Maybe ByteString)
- data ListSessionsResponse
- listSessionsResponse :: ListSessionsResponse
- lsrNextPageToken :: Lens' ListSessionsResponse (Maybe Text)
- lsrSessions :: Lens' ListSessionsResponse [Session]
- data ExecuteBatchDmlRequest
- executeBatchDmlRequest :: ExecuteBatchDmlRequest
- ebdrSeqno :: Lens' ExecuteBatchDmlRequest (Maybe Int64)
- ebdrTransaction :: Lens' ExecuteBatchDmlRequest (Maybe TransactionSelector)
- ebdrStatements :: Lens' ExecuteBatchDmlRequest [Statement]
- data StructType
- structType :: StructType
- stFields :: Lens' StructType [Field]
- data DatabaseState
- data Xgafv
- data CommitResponse
- commitResponse :: CommitResponse
- crCommitTimestamp :: Lens' CommitResponse (Maybe UTCTime)
- data Partition
- partition :: Partition
- pPartitionToken :: Lens' Partition (Maybe ByteString)
- data TestIAMPermissionsRequest
- testIAMPermissionsRequest :: TestIAMPermissionsRequest
- tiprPermissions :: Lens' TestIAMPermissionsRequest [Text]
- data PartitionQueryRequestParamTypes
- partitionQueryRequestParamTypes :: HashMap Text Type -> PartitionQueryRequestParamTypes
- pqrptAddtional :: Lens' PartitionQueryRequestParamTypes (HashMap Text Type)
- data UpdateInstanceMetadata
- updateInstanceMetadata :: UpdateInstanceMetadata
- uimStartTime :: Lens' UpdateInstanceMetadata (Maybe UTCTime)
- uimCancelTime :: Lens' UpdateInstanceMetadata (Maybe UTCTime)
- uimEndTime :: Lens' UpdateInstanceMetadata (Maybe UTCTime)
- uimInstance :: Lens' UpdateInstanceMetadata (Maybe Instance)
- data PlanNodeExecutionStats
- planNodeExecutionStats :: HashMap Text JSONValue -> PlanNodeExecutionStats
- pnesAddtional :: Lens' PlanNodeExecutionStats (HashMap Text JSONValue)
- data TestIAMPermissionsResponse
- testIAMPermissionsResponse :: TestIAMPermissionsResponse
- tiamprPermissions :: Lens' TestIAMPermissionsResponse [Text]
- data PartialResultSet
- partialResultSet :: PartialResultSet
- prsResumeToken :: Lens' PartialResultSet (Maybe ByteString)
- prsValues :: Lens' PartialResultSet [JSONValue]
- prsStats :: Lens' PartialResultSet (Maybe ResultSetStats)
- prsMetadata :: Lens' PartialResultSet (Maybe ResultSetMetadata)
- prsChunkedValue :: Lens' PartialResultSet (Maybe Bool)
- data Policy
- policy :: Policy
- pEtag :: Lens' Policy (Maybe ByteString)
- pVersion :: Lens' Policy (Maybe Int32)
- pBindings :: Lens' Policy [Binding]
- data CreateDatabaseRequest
- createDatabaseRequest :: CreateDatabaseRequest
- cdrExtraStatements :: Lens' CreateDatabaseRequest [Text]
- cdrCreateStatement :: Lens' CreateDatabaseRequest (Maybe Text)
- data ExecuteSQLRequest
- executeSQLRequest :: ExecuteSQLRequest
- esqlrParamTypes :: Lens' ExecuteSQLRequest (Maybe ExecuteSQLRequestParamTypes)
- esqlrResumeToken :: Lens' ExecuteSQLRequest (Maybe ByteString)
- esqlrSeqno :: Lens' ExecuteSQLRequest (Maybe Int64)
- esqlrParams :: Lens' ExecuteSQLRequest (Maybe ExecuteSQLRequestParams)
- esqlrTransaction :: Lens' ExecuteSQLRequest (Maybe TransactionSelector)
- esqlrSQL :: Lens' ExecuteSQLRequest (Maybe Text)
- esqlrPartitionToken :: Lens' ExecuteSQLRequest (Maybe ByteString)
- esqlrQueryMode :: Lens' ExecuteSQLRequest (Maybe ExecuteSQLRequestQueryMode)
- data CommitRequest
- commitRequest :: CommitRequest
- crMutations :: Lens' CommitRequest [Mutation]
- crTransactionId :: Lens' CommitRequest (Maybe ByteString)
- crSingleUseTransaction :: Lens' CommitRequest (Maybe TransactionOptions)
- data Type
- type' :: Type
- tArrayElementType :: Lens' Type (Maybe Type)
- tStructType :: Lens' Type (Maybe StructType)
- tCode :: Lens' Type (Maybe TypeCode)
- data CreateInstanceMetadata
- createInstanceMetadata :: CreateInstanceMetadata
- cimStartTime :: Lens' CreateInstanceMetadata (Maybe UTCTime)
- cimCancelTime :: Lens' CreateInstanceMetadata (Maybe UTCTime)
- cimEndTime :: Lens' CreateInstanceMetadata (Maybe UTCTime)
- cimInstance :: Lens' CreateInstanceMetadata (Maybe Instance)
- data KeyRange
- keyRange :: KeyRange
- krStartClosed :: Lens' KeyRange [JSONValue]
- krEndOpen :: Lens' KeyRange [JSONValue]
- krStartOpen :: Lens' KeyRange [JSONValue]
- krEndClosed :: Lens' KeyRange [JSONValue]
- data OperationMetadata
- operationMetadata :: HashMap Text JSONValue -> OperationMetadata
- omAddtional :: Lens' OperationMetadata (HashMap Text JSONValue)
- data InstanceConfig
- instanceConfig :: InstanceConfig
- icName :: Lens' InstanceConfig (Maybe Text)
- icDisplayName :: Lens' InstanceConfig (Maybe Text)
- data ResultSet
- resultSet :: ResultSet
- rsStats :: Lens' ResultSet (Maybe ResultSetStats)
- rsRows :: Lens' ResultSet [[JSONValue]]
- rsMetadata :: Lens' ResultSet (Maybe ResultSetMetadata)
- data SessionLabels
- sessionLabels :: HashMap Text Text -> SessionLabels
- slAddtional :: Lens' SessionLabels (HashMap Text Text)
- data ListInstancesResponse
- listInstancesResponse :: ListInstancesResponse
- lirNextPageToken :: Lens' ListInstancesResponse (Maybe Text)
- lirInstances :: Lens' ListInstancesResponse [Instance]
- data ReadRequest
- readRequest :: ReadRequest
- rrResumeToken :: Lens' ReadRequest (Maybe ByteString)
- rrKeySet :: Lens' ReadRequest (Maybe KeySet)
- rrTransaction :: Lens' ReadRequest (Maybe TransactionSelector)
- rrColumns :: Lens' ReadRequest [Text]
- rrLimit :: Lens' ReadRequest (Maybe Int64)
- rrIndex :: Lens' ReadRequest (Maybe Text)
- rrTable :: Lens' ReadRequest (Maybe Text)
- rrPartitionToken :: Lens' ReadRequest (Maybe ByteString)
- data InstanceState
- data Session
- session :: Session
- sApproximateLastUseTime :: Lens' Session (Maybe UTCTime)
- sName :: Lens' Session (Maybe Text)
- sLabels :: Lens' Session (Maybe SessionLabels)
- sCreateTime :: Lens' Session (Maybe UTCTime)
- data OperationResponse
- operationResponse :: HashMap Text JSONValue -> OperationResponse
- orAddtional :: Lens' OperationResponse (HashMap Text JSONValue)
- data ReadOnly
- readOnly :: ReadOnly
- roReadTimestamp :: Lens' ReadOnly (Maybe UTCTime)
- roExactStaleness :: Lens' ReadOnly (Maybe Scientific)
- roMaxStaleness :: Lens' ReadOnly (Maybe Scientific)
- roStrong :: Lens' ReadOnly (Maybe Bool)
- roMinReadTimestamp :: Lens' ReadOnly (Maybe UTCTime)
- roReturnReadTimestamp :: Lens' ReadOnly (Maybe Bool)
- data ResultSetMetadata
- resultSetMetadata :: ResultSetMetadata
- rsmRowType :: Lens' ResultSetMetadata (Maybe StructType)
- rsmTransaction :: Lens' ResultSetMetadata (Maybe Transaction)
- data Delete'
- delete' :: Delete'
- dKeySet :: Lens' Delete' (Maybe KeySet)
- dTable :: Lens' Delete' (Maybe Text)
- data UpdateInstanceRequest
- updateInstanceRequest :: UpdateInstanceRequest
- uirFieldMask :: Lens' UpdateInstanceRequest (Maybe GFieldMask)
- uirInstance :: Lens' UpdateInstanceRequest (Maybe Instance)
- data ResultSetStatsQueryStats
- resultSetStatsQueryStats :: HashMap Text JSONValue -> ResultSetStatsQueryStats
- rssqsAddtional :: Lens' ResultSetStatsQueryStats (HashMap Text JSONValue)
- data StatementParams
- statementParams :: HashMap Text JSONValue -> StatementParams
- spAddtional :: Lens' StatementParams (HashMap Text JSONValue)
- data TransactionSelector
- transactionSelector :: TransactionSelector
- tsBegin :: Lens' TransactionSelector (Maybe TransactionOptions)
- tsId :: Lens' TransactionSelector (Maybe ByteString)
- tsSingleUse :: Lens' TransactionSelector (Maybe TransactionOptions)
- data ListInstanceConfigsResponse
- listInstanceConfigsResponse :: ListInstanceConfigsResponse
- licrNextPageToken :: Lens' ListInstanceConfigsResponse (Maybe Text)
- licrInstanceConfigs :: Lens' ListInstanceConfigsResponse [InstanceConfig]
- data Binding
- binding :: Binding
- bMembers :: Lens' Binding [Text]
- bRole :: Lens' Binding (Maybe Text)
- bCondition :: Lens' Binding (Maybe Expr)
- data PartitionResponse
- partitionResponse :: PartitionResponse
- prPartitions :: Lens' PartitionResponse [Partition]
- prTransaction :: Lens' PartitionResponse (Maybe Transaction)
- data PartitionQueryRequest
- partitionQueryRequest :: PartitionQueryRequest
- pqrParamTypes :: Lens' PartitionQueryRequest (Maybe PartitionQueryRequestParamTypes)
- pqrPartitionOptions :: Lens' PartitionQueryRequest (Maybe PartitionOptions)
- pqrParams :: Lens' PartitionQueryRequest (Maybe PartitionQueryRequestParams)
- pqrTransaction :: Lens' PartitionQueryRequest (Maybe TransactionSelector)
- pqrSQL :: Lens' PartitionQueryRequest (Maybe Text)
- data QueryPlan
- queryPlan :: QueryPlan
- qpPlanNodes :: Lens' QueryPlan [PlanNode]
- data Instance
- instance' :: Instance
- iState :: Lens' Instance (Maybe InstanceState)
- iConfig :: Lens' Instance (Maybe Text)
- iNodeCount :: Lens' Instance (Maybe Int32)
- iName :: Lens' Instance (Maybe Text)
- iDisplayName :: Lens' Instance (Maybe Text)
- iLabels :: Lens' Instance (Maybe InstanceLabels)
Service Configuration
spannerService :: ServiceConfig Source #
Default request referring to version v1
of the Cloud Spanner API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] Source #
View and manage your data across Google Cloud Platform services
spannerDataScope :: Proxy '["https://www.googleapis.com/auth/spanner.data"] Source #
View and manage the contents of your Spanner databases
spannerAdminScope :: Proxy '["https://www.googleapis.com/auth/spanner.admin"] Source #
Administer your Spanner databases
API Declaration
type SpannerAPI = ProjectsInstancesOperationsListResource :<|> (ProjectsInstancesOperationsGetResource :<|> (ProjectsInstancesOperationsCancelResource :<|> (ProjectsInstancesOperationsDeleteResource :<|> (ProjectsInstancesDatabasesSessionsListResource :<|> (ProjectsInstancesDatabasesSessionsReadResource :<|> (ProjectsInstancesDatabasesSessionsExecuteStreamingSQLResource :<|> (ProjectsInstancesDatabasesSessionsPartitionQueryResource :<|> (ProjectsInstancesDatabasesSessionsBeginTransactionResource :<|> (ProjectsInstancesDatabasesSessionsGetResource :<|> (ProjectsInstancesDatabasesSessionsRollbackResource :<|> (ProjectsInstancesDatabasesSessionsCreateResource :<|> (ProjectsInstancesDatabasesSessionsPartitionReadResource :<|> (ProjectsInstancesDatabasesSessionsExecuteBatchDmlResource :<|> (ProjectsInstancesDatabasesSessionsStreamingReadResource :<|> (ProjectsInstancesDatabasesSessionsDeleteResource :<|> (ProjectsInstancesDatabasesSessionsExecuteSQLResource :<|> (ProjectsInstancesDatabasesSessionsCommitResource :<|> (ProjectsInstancesDatabasesOperationsListResource :<|> (ProjectsInstancesDatabasesOperationsGetResource :<|> (ProjectsInstancesDatabasesOperationsCancelResource :<|> (ProjectsInstancesDatabasesOperationsDeleteResource :<|> (ProjectsInstancesDatabasesDropDatabaseResource :<|> (ProjectsInstancesDatabasesListResource :<|> (ProjectsInstancesDatabasesUpdateDdlResource :<|> (ProjectsInstancesDatabasesGetIAMPolicyResource :<|> (ProjectsInstancesDatabasesGetResource :<|> (ProjectsInstancesDatabasesCreateResource :<|> (ProjectsInstancesDatabasesSetIAMPolicyResource :<|> (ProjectsInstancesDatabasesGetDdlResource :<|> (ProjectsInstancesDatabasesTestIAMPermissionsResource :<|> (ProjectsInstancesListResource :<|> (ProjectsInstancesGetIAMPolicyResource :<|> (ProjectsInstancesPatchResource :<|> (ProjectsInstancesGetResource :<|> (ProjectsInstancesCreateResource :<|> (ProjectsInstancesSetIAMPolicyResource :<|> (ProjectsInstancesTestIAMPermissionsResource :<|> (ProjectsInstancesDeleteResource :<|> (ProjectsInstanceConfigsListResource :<|> ProjectsInstanceConfigsGetResource))))))))))))))))))))))))))))))))))))))) Source #
Represents the entirety of the methods and resources available for the Cloud Spanner API service.
Resources
spanner.projects.instanceConfigs.get
spanner.projects.instanceConfigs.list
spanner.projects.instances.create
spanner.projects.instances.databases.create
spanner.projects.instances.databases.dropDatabase
spanner.projects.instances.databases.get
spanner.projects.instances.databases.getDdl
spanner.projects.instances.databases.getIamPolicy
spanner.projects.instances.databases.list
spanner.projects.instances.databases.operations.cancel
spanner.projects.instances.databases.operations.delete
spanner.projects.instances.databases.operations.get
spanner.projects.instances.databases.operations.list
spanner.projects.instances.databases.sessions.beginTransaction
spanner.projects.instances.databases.sessions.commit
spanner.projects.instances.databases.sessions.create
spanner.projects.instances.databases.sessions.delete
spanner.projects.instances.databases.sessions.executeBatchDml
spanner.projects.instances.databases.sessions.executeSql
spanner.projects.instances.databases.sessions.executeStreamingSql
spanner.projects.instances.databases.sessions.get
spanner.projects.instances.databases.sessions.list
spanner.projects.instances.databases.sessions.partitionQuery
spanner.projects.instances.databases.sessions.partitionRead
spanner.projects.instances.databases.sessions.read
spanner.projects.instances.databases.sessions.rollback
spanner.projects.instances.databases.sessions.streamingRead
spanner.projects.instances.databases.setIamPolicy
spanner.projects.instances.databases.testIamPermissions
spanner.projects.instances.databases.updateDdl
spanner.projects.instances.delete
spanner.projects.instances.get
spanner.projects.instances.getIamPolicy
spanner.projects.instances.list
spanner.projects.instances.operations.cancel
spanner.projects.instances.operations.delete
spanner.projects.instances.operations.get
spanner.projects.instances.operations.list
spanner.projects.instances.patch
spanner.projects.instances.setIamPolicy
spanner.projects.instances.testIamPermissions
Types
ExecuteSQLRequestParams
data ExecuteSQLRequestParams Source #
The SQL string can contain parameter placeholders. A parameter placeholder consists of `'''` followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > 'msg_id AND id < 'msg_id + 100"` It is an error to execute an SQL statement with unbound parameters. Parameter values are specified using `params`, which is a JSON object whose keys are parameter names, and whose values are the corresponding parameter values.
See: executeSQLRequestParams
smart constructor.
Instances
executeSQLRequestParams Source #
Creates a value of ExecuteSQLRequestParams
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
esqlrpAddtional :: Lens' ExecuteSQLRequestParams (HashMap Text JSONValue) Source #
Properties of the object.
InstanceLabels
data InstanceLabels Source #
Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release.
See: instanceLabels
smart constructor.
Instances
Creates a value of InstanceLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
CreateDatabaseMetadata
data CreateDatabaseMetadata Source #
Metadata type for the operation returned by CreateDatabase.
See: createDatabaseMetadata
smart constructor.
Instances
createDatabaseMetadata :: CreateDatabaseMetadata Source #
Creates a value of CreateDatabaseMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdmDatabase :: Lens' CreateDatabaseMetadata (Maybe Text) Source #
The database being created.
TransactionOptions
data TransactionOptions Source #
# Transactions Each session can have at most one active transaction at a time. After the active transaction is completed, the session can immediately be re-used for the next transaction. It is not necessary to create a new session for each transaction. # Transaction Modes Cloud Spanner supports three transaction modes: 1. Locking read-write. This type of transaction is the only way to write data into Cloud Spanner. These transactions rely on pessimistic locking and, if necessary, two-phase commit. Locking read-write transactions may abort, requiring the application to retry. 2. Snapshot read-only. This transaction type provides guaranteed consistency across several reads, but does not allow writes. Snapshot read-only transactions can be configured to read at timestamps in the past. Snapshot read-only transactions do not need to be committed. 3. Partitioned DML. This type of transaction is used to execute a single Partitioned DML statement. Partitioned DML partitions the key space and runs the DML statement over each partition in parallel using separate, internal transactions that commit independently. Partitioned DML transactions do not need to be committed. For transactions that only read, snapshot read-only transactions provide simpler semantics and are almost always faster. In particular, read-only transactions do not take locks, so they do not conflict with read-write transactions. As a consequence of not taking locks, they also do not abort, so retry loops are not needed. Transactions may only read/write data in a single database. They may, however, read/write data in different tables within that database. ## Locking Read-Write Transactions Locking transactions may be used to atomically read-modify-write data anywhere in a database. This type of transaction is externally consistent. Clients should attempt to minimize the amount of time a transaction is active. Faster transactions commit with higher probability and cause less contention. Cloud Spanner attempts to keep read locks active as long as the transaction continues to do reads, and the transaction has not been terminated by Commit or Rollback. Long periods of inactivity at the client may cause Cloud Spanner to release a transaction's locks and abort it. Conceptually, a read-write transaction consists of zero or more reads or SQL statements followed by Commit. At any time before Commit, the client can send a Rollback request to abort the transaction. ### Semantics Cloud Spanner can commit the transaction if all read locks it acquired are still valid at commit time, and it is able to acquire write locks for all writes. Cloud Spanner can abort the transaction for any reason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees that the transaction has not modified any user data in Cloud Spanner. Unless the transaction commits, Cloud Spanner makes no guarantees about how long the transaction's locks were held for. It is an error to use Cloud Spanner locks for any sort of mutual exclusion other than between Cloud Spanner transactions themselves. ### Retrying Aborted Transactions When a transaction aborts, the application can choose to retry the whole transaction again. To maximize the chances of successfully committing the retry, the client should execute the retry in the same session as the original attempt. The original session's lock priority increases with each consecutive abort, meaning that each attempt has a slightly better chance of success than the previous. Under some circumstances (e.g., many transactions attempting to modify the same row(s)), a transaction can abort many times in a short period before successfully committing. Thus, it is not a good idea to cap the number of retries a transaction can attempt; instead, it is better to limit the total amount of wall time spent retrying. ### Idle Transactions A transaction is considered idle if it has no outstanding reads or SQL queries and has not started a read or SQL query within the last 10 seconds. Idle transactions can be aborted by Cloud Spanner so that they don't hold on to locks indefinitely. In that case, the commit will fail with error `ABORTED`. If this behavior is undesirable, periodically executing a simple SQL query in the transaction (e.g., `SELECT 1`) prevents the transaction from becoming idle. ## Snapshot Read-Only Transactions Snapshot read-only transactions provides a simpler method than locking read-write transactions for doing several consistent reads. However, this type of transaction does not support writes. Snapshot transactions do not take locks. Instead, they work by choosing a Cloud Spanner timestamp, then executing all reads at that timestamp. Since they do not acquire locks, they do not block concurrent read-write transactions. Unlike locking read-write transactions, snapshot read-only transactions never abort. They can fail if the chosen read timestamp is garbage collected; however, the default garbage collection policy is generous enough that most applications do not need to worry about this in practice. Snapshot read-only transactions do not need to call Commit or Rollback (and in fact are not permitted to do so). To execute a snapshot transaction, the client specifies a timestamp bound, which tells Cloud Spanner how to choose a read timestamp. The types of timestamp bound are: - Strong (the default). - Bounded staleness. - Exact staleness. If the Cloud Spanner database to be read is geographically distributed, stale read-only transactions can execute more quickly than strong or read-write transaction, because they are able to execute far from the leader replica. Each type of timestamp bound is discussed in detail below. ### Strong Strong reads are guaranteed to see the effects of all transactions that have committed before the start of the read. Furthermore, all rows yielded by a single read are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction. Strong reads are not repeatable: two consecutive strong read-only transactions might return inconsistent results if there are concurrent writes. If consistency across reads is required, the reads should be executed within a transaction or at an exact read timestamp. See TransactionOptions.ReadOnly.strong. ### Exact Staleness These timestamp bounds execute reads at a user-specified timestamp. Reads at a timestamp are guaranteed to see a consistent prefix of the global transaction history: they observe modifications done by all transactions with a commit timestamp <= the read timestamp, and observe none of the modifications done by transactions with a larger commit timestamp. They will block until all conflicting transactions that may be assigned commit timestamps <= the read timestamp have finished. The timestamp can either be expressed as an absolute Cloud Spanner commit timestamp or a staleness relative to the current time. These modes do not require a "negotiation phase" to pick a timestamp. As a result, they execute slightly faster than the equivalent boundedly stale concurrency modes. On the other hand, boundedly stale reads usually return fresher results. See TransactionOptions.ReadOnly.read_timestamp and TransactionOptions.ReadOnly.exact_staleness. ### Bounded Staleness Bounded staleness modes allow Cloud Spanner to pick the read timestamp, subject to a user-provided staleness bound. Cloud Spanner chooses the newest timestamp within the staleness bound that allows execution of the reads at the closest available replica without blocking. All rows yielded are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction. Boundedly stale reads are not repeatable: two stale reads, even if they use the same staleness bound, can execute at different timestamps and thus return inconsistent results. Boundedly stale reads execute in two phases: the first phase negotiates a timestamp among all replicas needed to serve the read. In the second phase, reads are executed at the negotiated timestamp. As a result of the two phase execution, bounded staleness reads are usually a little slower than comparable exact staleness reads. However, they are typically able to return fresher results, and are more likely to execute at the closest replica. Because the timestamp negotiation requires up-front knowledge of which rows will be read, it can only be used with single-use read-only transactions. See TransactionOptions.ReadOnly.max_staleness and TransactionOptions.ReadOnly.min_read_timestamp. ### Old Read Timestamps and Garbage Collection Cloud Spanner continuously garbage collects deleted and overwritten data in the background to reclaim storage space. This process is known as "version GC". By default, version GC reclaims versions after they are one hour old. Because of this, Cloud Spanner cannot perform reads at read timestamps more than one hour in the past. This restriction also applies to in-progress reads and/or SQL queries whose timestamp become too old while executing. Reads and SQL queries with too-old read timestamps fail with the error `FAILED_PRECONDITION`. ## Partitioned DML Transactions Partitioned DML transactions are used to execute DML statements with a different execution strategy that provides different, and often better, scalability properties for large, table-wide operations than DML in a ReadWrite transaction. Smaller scoped statements, such as an OLTP workload, should prefer using ReadWrite transactions. Partitioned DML partitions the keyspace and runs the DML statement on each partition in separate, internal transactions. These transactions commit automatically when complete, and run independently from one another. To reduce lock contention, this execution strategy only acquires read locks on rows that match the WHERE clause of the statement. Additionally, the smaller per-partition transactions hold locks for less time. That said, Partitioned DML is not a drop-in replacement for standard DML used in ReadWrite transactions. - The DML statement must be fully-partitionable. Specifically, the statement must be expressible as the union of many statements which each access only a single row of the table. - The statement is not applied atomically to all rows of the table. Rather, the statement is applied atomically to partitions of the table, in independent transactions. Secondary index rows are updated atomically with the base table rows. - Partitioned DML does not guarantee exactly-once execution semantics against a partition. The statement will be applied at least once to each partition. It is strongly recommended that the DML statement should be idempotent to avoid unexpected results. For instance, it is potentially dangerous to run a statement such as `UPDATE table SET column = column + 1` as it could be run multiple times against some rows. - The partitions are committed automatically - there is no support for Commit or Rollback. If the call returns an error, or if the client issuing the ExecuteSql call dies, it is possible that some rows had the statement executed on them successfully. It is also possible that statement was never executed against other rows. - Partitioned DML transactions may only contain the execution of a single DML statement via ExecuteSql or ExecuteStreamingSql. - If any error is encountered during the execution of the partitioned DML operation (for instance, a UNIQUE INDEX violation, division by zero, or a value that cannot be stored due to schema constraints), then the operation is stopped at that point and an error is returned. It is possible that at this point, some partitions have been committed (or even committed multiple times), and other partitions have not been run at all. Given the above, Partitioned DML is good fit for large, database-wide, operations that are idempotent, such as deleting old rows from a very large table.
See: transactionOptions
smart constructor.
Instances
transactionOptions :: TransactionOptions Source #
Creates a value of TransactionOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
toReadWrite :: Lens' TransactionOptions (Maybe ReadWrite) Source #
Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource.
toPartitionedDml :: Lens' TransactionOptions (Maybe PartitionedDml) Source #
Partitioned DML transaction. Authorization to begin a Partitioned DML transaction requires `spanner.databases.beginPartitionedDmlTransaction` permission on the `session` resource.
toReadOnly :: Lens' TransactionOptions (Maybe ReadOnly) Source #
Transaction will not write. Authorization to begin a read-only transaction requires `spanner.databases.beginReadOnlyTransaction` permission on the `session` resource.
GetDatabaseDdlResponse
data GetDatabaseDdlResponse Source #
The response for GetDatabaseDdl.
See: getDatabaseDdlResponse
smart constructor.
Instances
getDatabaseDdlResponse :: GetDatabaseDdlResponse Source #
Creates a value of GetDatabaseDdlResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gddrStatements :: Lens' GetDatabaseDdlResponse [Text] Source #
A list of formatted DDL statements defining the schema of the database specified in the request.
Status
The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
See: status
smart constructor.
Instances
Eq Status Source # | |
Data Status Source # | |
Defined in Network.Google.Spanner.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Status -> c Status # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Status # toConstr :: Status -> Constr # dataTypeOf :: Status -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Status) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Status) # gmapT :: (forall b. Data b => b -> b) -> Status -> Status # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQ :: (forall d. Data d => d -> u) -> Status -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Status -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # | |
Show Status Source # | |
Generic Status Source # | |
ToJSON Status Source # | |
Defined in Network.Google.Spanner.Types.Product | |
FromJSON Status Source # | |
type Rep Status Source # | |
Defined in Network.Google.Spanner.Types.Product type Rep Status = D1 (MetaData "Status" "Network.Google.Spanner.Types.Product" "gogol-spanner-0.5.0-EbKAd7GSsmo9VdnPLfZZzz" False) (C1 (MetaCons "Status'" PrefixI True) (S1 (MetaSel (Just "_sDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [StatusDetailsItem])) :*: (S1 (MetaSel (Just "_sCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_sMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
sDetails :: Lens' Status [StatusDetailsItem] Source #
A list of messages that carry the error details. There is a common set of message types for APIs to use.
sCode :: Lens' Status (Maybe Int32) Source #
The status code, which should be an enum value of google.rpc.Code.
sMessage :: Lens' Status (Maybe Text) Source #
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
CreateInstanceRequest
data CreateInstanceRequest Source #
The request for CreateInstance.
See: createInstanceRequest
smart constructor.
Instances
createInstanceRequest :: CreateInstanceRequest Source #
Creates a value of CreateInstanceRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cirInstanceId :: Lens' CreateInstanceRequest (Maybe Text) Source #
Required. The ID of the instance to create. Valid identifiers are of the form `a-z*[a-z0-9]` and must be between 2 and 64 characters in length.
cirInstance :: Lens' CreateInstanceRequest (Maybe Instance) Source #
Required. The instance to create. The name may be omitted, but if specified must be `/instances/`.
ReadWrite
Message type to initiate a read-write transaction. Currently this transaction type has no options.
See: readWrite
smart constructor.
Instances
Eq ReadWrite Source # | |
Data ReadWrite Source # | |
Defined in Network.Google.Spanner.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ReadWrite -> c ReadWrite # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ReadWrite # toConstr :: ReadWrite -> Constr # dataTypeOf :: ReadWrite -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ReadWrite) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ReadWrite) # gmapT :: (forall b. Data b => b -> b) -> ReadWrite -> ReadWrite # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ReadWrite -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ReadWrite -> r # gmapQ :: (forall d. Data d => d -> u) -> ReadWrite -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ReadWrite -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ReadWrite -> m ReadWrite # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ReadWrite -> m ReadWrite # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ReadWrite -> m ReadWrite # | |
Show ReadWrite Source # | |
Generic ReadWrite Source # | |
ToJSON ReadWrite Source # | |
Defined in Network.Google.Spanner.Types.Product | |
FromJSON ReadWrite Source # | |
type Rep ReadWrite Source # | |
readWrite :: ReadWrite Source #
Creates a value of ReadWrite
with the minimum fields required to make a request.
RollbackRequest
data RollbackRequest Source #
The request for Rollback.
See: rollbackRequest
smart constructor.
Instances
rollbackRequest :: RollbackRequest Source #
Creates a value of RollbackRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrTransactionId :: Lens' RollbackRequest (Maybe ByteString) Source #
Required. The transaction to roll back.
ListDatabasesResponse
data ListDatabasesResponse Source #
The response for ListDatabases.
See: listDatabasesResponse
smart constructor.
Instances
listDatabasesResponse :: ListDatabasesResponse Source #
Creates a value of ListDatabasesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ldrNextPageToken :: Lens' ListDatabasesResponse (Maybe Text) Source #
`next_page_token` can be sent in a subsequent ListDatabases call to fetch more of the matching databases.
ldrDatabases :: Lens' ListDatabasesResponse [Database] Source #
Databases that matched the request.
Expr
Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0"
See: expr
smart constructor.
Instances
Eq Expr Source # | |
Data Expr Source # | |
Defined in Network.Google.Spanner.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Expr -> c Expr # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Expr # dataTypeOf :: Expr -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Expr) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Expr) # gmapT :: (forall b. Data b => b -> b) -> Expr -> Expr # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Expr -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Expr -> r # gmapQ :: (forall d. Data d => d -> u) -> Expr -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Expr -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Expr -> m Expr # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Expr -> m Expr # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Expr -> m Expr # | |
Show Expr Source # | |
Generic Expr Source # | |
ToJSON Expr Source # | |
Defined in Network.Google.Spanner.Types.Product | |
FromJSON Expr Source # | |
type Rep Expr Source # | |
Defined in Network.Google.Spanner.Types.Product type Rep Expr = D1 (MetaData "Expr" "Network.Google.Spanner.Types.Product" "gogol-spanner-0.5.0-EbKAd7GSsmo9VdnPLfZZzz" False) (C1 (MetaCons "Expr'" PrefixI True) ((S1 (MetaSel (Just "_eLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_eExpression") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_eTitle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_eDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
Creates a value of Expr
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eLocation :: Lens' Expr (Maybe Text) Source #
An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
eExpression :: Lens' Expr (Maybe Text) Source #
Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported.
eTitle :: Lens' Expr (Maybe Text) Source #
An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
eDescription :: Lens' Expr (Maybe Text) Source #
An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
ListOperationsResponse
data ListOperationsResponse Source #
The response message for Operations.ListOperations.
See: listOperationsResponse
smart constructor.
Instances
listOperationsResponse :: ListOperationsResponse Source #
Creates a value of ListOperationsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lorNextPageToken :: Lens' ListOperationsResponse (Maybe Text) Source #
The standard List next-page token.
lorOperations :: Lens' ListOperationsResponse [Operation] Source #
A list of operations that matches the specified filter in the request.
GetIAMPolicyRequest
data GetIAMPolicyRequest Source #
Request message for `GetIamPolicy` method.
See: getIAMPolicyRequest
smart constructor.
Instances
getIAMPolicyRequest :: GetIAMPolicyRequest Source #
Creates a value of GetIAMPolicyRequest
with the minimum fields required to make a request.
ChildLink
Metadata associated with a parent-child relationship appearing in a PlanNode.
See: childLink
smart constructor.
Instances
Eq ChildLink Source # | |
Data ChildLink Source # | |
Defined in Network.Google.Spanner.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ChildLink -> c ChildLink # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ChildLink # toConstr :: ChildLink -> Constr # dataTypeOf :: ChildLink -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ChildLink) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ChildLink) # gmapT :: (forall b. Data b => b -> b) -> ChildLink -> ChildLink # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ChildLink -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ChildLink -> r # gmapQ :: (forall d. Data d => d -> u) -> ChildLink -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ChildLink -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ChildLink -> m ChildLink # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ChildLink -> m ChildLink # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ChildLink -> m ChildLink # | |
Show ChildLink Source # | |
Generic ChildLink Source # | |
ToJSON ChildLink Source # | |
Defined in Network.Google.Spanner.Types.Product | |
FromJSON ChildLink Source # | |
type Rep ChildLink Source # | |
Defined in Network.Google.Spanner.Types.Product type Rep ChildLink = D1 (MetaData "ChildLink" "Network.Google.Spanner.Types.Product" "gogol-spanner-0.5.0-EbKAd7GSsmo9VdnPLfZZzz" False) (C1 (MetaCons "ChildLink'" PrefixI True) (S1 (MetaSel (Just "_clChildIndex") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: (S1 (MetaSel (Just "_clVariable") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_clType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
childLink :: ChildLink Source #
Creates a value of ChildLink
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
clVariable :: Lens' ChildLink (Maybe Text) Source #
Only present if the child node is SCALAR and corresponds to an output variable of the parent node. The field carries the name of the output variable. For example, a `TableScan` operator that reads rows from a table will have child links to the `SCALAR` nodes representing the output variables created for each column that is read by the operator. The corresponding `variable` fields will be set to the variable names assigned to the columns.
clType :: Lens' ChildLink (Maybe Text) Source #
The type of the link. For example, in Hash Joins this could be used to distinguish between the build child and the probe child, or in the case of the child being an output variable, to represent the tag associated with the output variable.
BeginTransactionRequest
data BeginTransactionRequest Source #
The request for BeginTransaction.
See: beginTransactionRequest
smart constructor.
Instances
beginTransactionRequest :: BeginTransactionRequest Source #
Creates a value of BeginTransactionRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
btrOptions :: Lens' BeginTransactionRequest (Maybe TransactionOptions) Source #
Required. Options for the new transaction.
PartitionOptions
data PartitionOptions Source #
Options for a PartitionQueryRequest and PartitionReadRequest.
See: partitionOptions
smart constructor.
Instances
partitionOptions :: PartitionOptions Source #
Creates a value of PartitionOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
poMaxPartitions :: Lens' PartitionOptions (Maybe Int64) Source #
- *Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests. The desired maximum number of partitions to return. For example, this may be set to the number of workers available. The default for this option is currently 10,000. The maximum value is currently 200,000. This is only a hint. The actual number of partitions returned may be smaller or larger than this maximum count request.
poPartitionSizeBytes :: Lens' PartitionOptions (Maybe Int64) Source #
- *Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests. The desired data size for each partition generated. The default for this option is currently 1 GiB. This is only a hint. The actual size of each partition may be smaller or larger than this size request.
ResultSetStats
data ResultSetStats Source #
Additional statistics about a ResultSet or PartialResultSet.
See: resultSetStats
smart constructor.
Instances
resultSetStats :: ResultSetStats Source #
Creates a value of ResultSetStats
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rssRowCountExact :: Lens' ResultSetStats (Maybe Int64) Source #
Standard DML returns an exact count of rows that were modified.
rssRowCountLowerBound :: Lens' ResultSetStats (Maybe Int64) Source #
Partitioned DML does not offer exactly-once semantics, so it returns a lower bound of the rows modified.
rssQueryStats :: Lens' ResultSetStats (Maybe ResultSetStatsQueryStats) Source #
Aggregated statistics from the execution of the query. Only present when the query is profiled. For example, a query could return the statistics as follows: { "rows_returned": "3", "elapsed_time": "1.22 secs", "cpu_time": "1.19 secs" }
rssQueryPlan :: Lens' ResultSetStats (Maybe QueryPlan) Source #
QueryPlan for the query associated with this result.
Field
Message representing a single field of a struct.
See: field
smart constructor.
Instances
Eq Field Source # | |
Data Field Source # | |
Defined in Network.Google.Spanner.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Field -> c Field # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Field # dataTypeOf :: Field -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Field) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Field) # gmapT :: (forall b. Data b => b -> b) -> Field -> Field # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Field -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Field -> r # gmapQ :: (forall d. Data d => d -> u) -> Field -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Field -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Field -> m Field # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Field -> m Field # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Field -> m Field # | |
Show Field Source # | |
Generic Field Source # | |
ToJSON Field Source # | |
Defined in Network.Google.Spanner.Types.Product | |
FromJSON Field Source # | |
type Rep Field Source # | |
Defined in Network.Google.Spanner.Types.Product type Rep Field = D1 (MetaData "Field" "Network.Google.Spanner.Types.Product" "gogol-spanner-0.5.0-EbKAd7GSsmo9VdnPLfZZzz" False) (C1 (MetaCons "Field'" PrefixI True) (S1 (MetaSel (Just "_fName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_fType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Type)))) |
fName :: Lens' Field (Maybe Text) Source #
The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., !"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
TypeCode
Required. The TypeCode for this type.
TypeCodeUnspecified |
|
Bool |
|
INT64 |
|
FLOAT64 |
|
Timestamp |
|
Date |
|
String |
|
Bytes |
|
Array |
|
Struct |
|
Instances
Write
Arguments to insert, update, insert_or_update, and replace operations.
See: write
smart constructor.
Instances
Eq Write Source # | |
Data Write Source # | |
Defined in Network.Google.Spanner.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Write -> c Write # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Write # dataTypeOf :: Write -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Write) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Write) # gmapT :: (forall b. Data b => b -> b) -> Write -> Write # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Write -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Write -> r # gmapQ :: (forall d. Data d => d -> u) -> Write -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Write -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Write -> m Write # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Write -> m Write # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Write -> m Write # | |
Show Write Source # | |
Generic Write Source # | |
ToJSON Write Source # | |
Defined in Network.Google.Spanner.Types.Product | |
FromJSON Write Source # | |
type Rep Write Source # | |
Defined in Network.Google.Spanner.Types.Product type Rep Write = D1 (MetaData "Write" "Network.Google.Spanner.Types.Product" "gogol-spanner-0.5.0-EbKAd7GSsmo9VdnPLfZZzz" False) (C1 (MetaCons "Write'" PrefixI True) (S1 (MetaSel (Just "_wValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [[JSONValue]])) :*: (S1 (MetaSel (Just "_wColumns") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_wTable") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
wValues :: Lens' Write [[JSONValue]] Source #
The values to be written. `values` can contain more than one list of values. If it does, then multiple rows are written, one for each entry in `values`. Each list in `values` must have exactly as many entries as there are entries in columns above. Sending multiple lists is equivalent to sending multiple `Mutation`s, each containing one `values` entry and repeating table and columns. Individual values in each list are encoded as described here.
wColumns :: Lens' Write [Text] Source #
The names of the columns in table to be written. The list of columns must contain enough columns to allow Cloud Spanner to derive values for all primary key columns in the row(s) to be modified.
KeySet
`KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All the keys are expected to be in the same table or index. The keys need not be sorted in any particular way. If the same key is specified multiple times in the set (for example if two ranges, two keys, or a key and a range overlap), Cloud Spanner behaves as if the key were only specified once.
See: keySet
smart constructor.
Instances
Eq KeySet Source # | |
Data KeySet Source # | |
Defined in Network.Google.Spanner.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> KeySet -> c KeySet # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c KeySet # toConstr :: KeySet -> Constr # dataTypeOf :: KeySet -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c KeySet) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c KeySet) # gmapT :: (forall b. Data b => b -> b) -> KeySet -> KeySet # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> KeySet -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> KeySet -> r # gmapQ :: (forall d. Data d => d -> u) -> KeySet -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> KeySet -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> KeySet -> m KeySet # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> KeySet -> m KeySet # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> KeySet -> m KeySet # | |
Show KeySet Source # | |
Generic KeySet Source # | |
ToJSON KeySet Source # | |
Defined in Network.Google.Spanner.Types.Product | |
FromJSON KeySet Source # | |
type Rep KeySet Source # | |
Defined in Network.Google.Spanner.Types.Product type Rep KeySet = D1 (MetaData "KeySet" "Network.Google.Spanner.Types.Product" "gogol-spanner-0.5.0-EbKAd7GSsmo9VdnPLfZZzz" False) (C1 (MetaCons "KeySet'" PrefixI True) (S1 (MetaSel (Just "_ksAll") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 (MetaSel (Just "_ksRanges") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [KeyRange])) :*: S1 (MetaSel (Just "_ksKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [[JSONValue]]))))) |
ksAll :: Lens' KeySet (Maybe Bool) Source #
For convenience `all` can be set to `true` to indicate that this `KeySet` matches all keys in the table or index. Note that any keys specified in `keys` or `ranges` are only yielded once.
ksRanges :: Lens' KeySet [KeyRange] Source #
A list of key ranges. See KeyRange for more information about key range specifications.
ksKeys :: Lens' KeySet [[JSONValue]] Source #
A list of specific keys. Entries in `keys` should have exactly as many elements as there are columns in the primary or index key with which this `KeySet` is used. Individual key values are encoded as described here.
Statement
A single DML statement.
See: statement
smart constructor.
Instances
Eq Statement Source # | |
Data Statement Source # | |
Defined in Network.Google.Spanner.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Statement -> c Statement # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Statement # toConstr :: Statement -> Constr # dataTypeOf :: Statement -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Statement) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Statement) # gmapT :: (forall b. Data b => b -> b) -> Statement -> Statement # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Statement -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Statement -> r # gmapQ :: (forall d. Data d => d -> u) -> Statement -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Statement -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Statement -> m Statement # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Statement -> m Statement # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Statement -> m Statement # | |
Show Statement Source # | |
Generic Statement Source # | |
ToJSON Statement Source # | |
Defined in Network.Google.Spanner.Types.Product | |
FromJSON Statement Source # | |
type Rep Statement Source # | |
Defined in Network.Google.Spanner.Types.Product type Rep Statement = D1 (MetaData "Statement" "Network.Google.Spanner.Types.Product" "gogol-spanner-0.5.0-EbKAd7GSsmo9VdnPLfZZzz" False) (C1 (MetaCons "Statement'" PrefixI True) (S1 (MetaSel (Just "_sParamTypes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe StatementParamTypes)) :*: (S1 (MetaSel (Just "_sParams") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe StatementParams)) :*: S1 (MetaSel (Just "_sSQL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
statement :: Statement Source #
Creates a value of Statement
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sParamTypes :: Lens' Statement (Maybe StatementParamTypes) Source #
It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types.
sParams :: Lens' Statement (Maybe StatementParams) Source #
The DML string can contain parameter placeholders. A parameter placeholder consists of `'''` followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > 'msg_id AND id < 'msg_id + 100"` It is an error to execute an SQL statement with unbound parameters. Parameter values are specified using `params`, which is a JSON object whose keys are parameter names, and whose values are the corresponding parameter values.
PartitionQueryRequestParams
data PartitionQueryRequestParams Source #
The SQL query string can contain parameter placeholders. A parameter placeholder consists of `'''` followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > 'msg_id AND id < 'msg_id + 100"` It is an error to execute an SQL query with unbound parameters. Parameter values are specified using `params`, which is a JSON object whose keys are parameter names, and whose values are the corresponding parameter values.
See: partitionQueryRequestParams
smart constructor.
Instances
partitionQueryRequestParams Source #
Creates a value of PartitionQueryRequestParams
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pqrpAddtional :: Lens' PartitionQueryRequestParams (HashMap Text JSONValue) Source #
Properties of the object.
ExecuteBatchDmlResponse
data ExecuteBatchDmlResponse Source #
The response for ExecuteBatchDml. Contains a list of ResultSet, one for each DML statement that has successfully executed. If a statement fails, the error is returned as part of the response payload. Clients can determine whether all DML statements have run successfully, or if a statement failed, using one of the following approaches: 1. Check if 'status' field is OkStatus. 2. Check if result_sets_size() equals the number of statements in ExecuteBatchDmlRequest. Example 1: A request with 5 DML statements, all executed successfully. Result: A response with 5 ResultSets, one for each statement in the same order, and an OK status. Example 2: A request with 5 DML statements. The 3rd statement has a syntax error. Result: A response with 2 ResultSets, for the first 2 statements that run successfully, and a syntax error (INVALID_ARGUMENT) status. From result_set_size() client can determine that the 3rd statement has failed.
See: executeBatchDmlResponse
smart constructor.
Instances
executeBatchDmlResponse :: ExecuteBatchDmlResponse Source #
Creates a value of ExecuteBatchDmlResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ebdrStatus :: Lens' ExecuteBatchDmlResponse (Maybe Status) Source #
If all DML statements are executed successfully, status will be OK. Otherwise, the error status of the first failed statement.
ebdrResultSets :: Lens' ExecuteBatchDmlResponse [ResultSet] Source #
ResultSets, one for each statement in the request that ran successfully, in the same order as the statements in the request. Each ResultSet will not contain any rows. The ResultSetStats in each ResultSet will contain the number of rows modified by the statement. Only the first ResultSet in the response contains a valid ResultSetMetadata.
Operation
This resource represents a long-running operation that is the result of a network API call.
See: operation
smart constructor.
Instances
oDone :: Lens' Operation (Maybe Bool) Source #
If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
oError :: Lens' Operation (Maybe Status) Source #
The error result of the operation in case of failure or cancellation.
oResponse :: Lens' Operation (Maybe OperationResponse) Source #
The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
oName :: Lens' Operation (Maybe Text) Source #
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
oMetadata :: Lens' Operation (Maybe OperationMetadata) Source #
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
UpdateDatabaseDdlMetadata
data UpdateDatabaseDdlMetadata Source #
Metadata type for the operation returned by UpdateDatabaseDdl.
See: updateDatabaseDdlMetadata
smart constructor.
Instances
updateDatabaseDdlMetadata :: UpdateDatabaseDdlMetadata Source #
Creates a value of UpdateDatabaseDdlMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uddmCommitTimestamps :: Lens' UpdateDatabaseDdlMetadata [UTCTime] Source #
Reports the commit timestamps of all statements that have succeeded so far, where `commit_timestamps[i]` is the commit timestamp for the statement `statements[i]`.
uddmDatabase :: Lens' UpdateDatabaseDdlMetadata (Maybe Text) Source #
The database being modified.
uddmStatements :: Lens' UpdateDatabaseDdlMetadata [Text] Source #
For an update this list contains all the statements. For an individual statement, this list contains only that statement.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
See: empty
smart constructor.
Instances
Eq Empty Source # | |
Data Empty Source # | |
Defined in Network.Google.Spanner.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Empty -> c Empty # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Empty # dataTypeOf :: Empty -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Empty) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Empty) # gmapT :: (forall b. Data b => b -> b) -> Empty -> Empty # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQ :: (forall d. Data d => d -> u) -> Empty -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Empty -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # | |
Show Empty Source # | |
Generic Empty Source # | |
ToJSON Empty Source # | |
Defined in Network.Google.Spanner.Types.Product | |
FromJSON Empty Source # | |
type Rep Empty Source # | |
Database
A Cloud Spanner database.
See: database
smart constructor.
Instances
Eq Database Source # | |
Data Database Source # | |
Defined in Network.Google.Spanner.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Database -> c Database # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Database # toConstr :: Database -> Constr # dataTypeOf :: Database -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Database) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Database) # gmapT :: (forall b. Data b => b -> b) -> Database -> Database # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Database -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Database -> r # gmapQ :: (forall d. Data d => d -> u) -> Database -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Database -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Database -> m Database # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Database -> m Database # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Database -> m Database # | |
Show Database Source # | |
Generic Database Source # | |
ToJSON Database Source # | |
Defined in Network.Google.Spanner.Types.Product | |
FromJSON Database Source # | |
type Rep Database Source # | |
Defined in Network.Google.Spanner.Types.Product type Rep Database = D1 (MetaData "Database" "Network.Google.Spanner.Types.Product" "gogol-spanner-0.5.0-EbKAd7GSsmo9VdnPLfZZzz" False) (C1 (MetaCons "Database'" PrefixI True) (S1 (MetaSel (Just "_dState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DatabaseState)) :*: S1 (MetaSel (Just "_dName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) |
dName :: Lens' Database (Maybe Text) Source #
Required. The name of the database. Values are of the form `projects//instances//databases/`, where `` is as specified in the `CREATE DATABASE` statement. This name can be passed to other API methods to identify the database.
PlanNode
Node information for nodes appearing in a QueryPlan.plan_nodes.
See: planNode
smart constructor.
Instances
Creates a value of PlanNode
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pnKind :: Lens' PlanNode (Maybe PlanNodeKind) Source #
Used to determine the type of node. May be needed for visualizing different kinds of nodes differently. For example, If the node is a SCALAR node, it will have a condensed representation which can be used to directly embed a description of the node in its parent.
pnShortRepresentation :: Lens' PlanNode (Maybe ShortRepresentation) Source #
Condensed representation for SCALAR nodes.
pnMetadata :: Lens' PlanNode (Maybe PlanNodeMetadata) Source #
Attributes relevant to the node contained in a group of key-value pairs. For example, a Parameter Reference node could have the following information in its metadata: { "parameter_reference": "param1", "parameter_type": "array" }
pnExecutionStats :: Lens' PlanNode (Maybe PlanNodeExecutionStats) Source #
The execution statistics associated with the node, contained in a group of key-value pairs. Only present if the plan was returned as a result of a profile query. For example, number of executions, number of rows/time per execution etc.
pnChildLinks :: Lens' PlanNode [ChildLink] Source #
List of child node `index`es and their relationship to this parent.
PlanNodeKind
data PlanNodeKind Source #
Used to determine the type of node. May be needed for visualizing different kinds of nodes differently. For example, If the node is a SCALAR node, it will have a condensed representation which can be used to directly embed a description of the node in its parent.
KindUnspecified |
|
Relational |
|
Scalar |
|
Instances
CreateSessionRequest
data CreateSessionRequest Source #
The request for CreateSession.
See: createSessionRequest
smart constructor.
Instances
createSessionRequest :: CreateSessionRequest Source #
Creates a value of CreateSessionRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
csrSession :: Lens' CreateSessionRequest (Maybe Session) Source #
The session to create.
ShortRepresentation
data ShortRepresentation Source #
Condensed representation of a node and its subtree. Only present for `SCALAR` PlanNode(s).
See: shortRepresentation
smart constructor.
Instances
shortRepresentation :: ShortRepresentation Source #
Creates a value of ShortRepresentation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srSubqueries :: Lens' ShortRepresentation (Maybe ShortRepresentationSubqueries) Source #
A mapping of (subquery variable name) -> (subquery node id) for cases where the `description` string of this node references a `SCALAR` subquery contained in the expression subtree rooted at this node. The referenced `SCALAR` subquery may not necessarily be a direct child of this node.
srDescription :: Lens' ShortRepresentation (Maybe Text) Source #
A string representation of the expression subtree rooted at this node.
ShortRepresentationSubqueries
data ShortRepresentationSubqueries Source #
A mapping of (subquery variable name) -> (subquery node id) for cases where the `description` string of this node references a `SCALAR` subquery contained in the expression subtree rooted at this node. The referenced `SCALAR` subquery may not necessarily be a direct child of this node.
See: shortRepresentationSubqueries
smart constructor.
Instances
shortRepresentationSubqueries Source #
Creates a value of ShortRepresentationSubqueries
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
StatusDetailsItem
data StatusDetailsItem Source #
Instances
Creates a value of StatusDetailsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
PlanNodeMetadata
data PlanNodeMetadata Source #
Attributes relevant to the node contained in a group of key-value pairs. For example, a Parameter Reference node could have the following information in its metadata: { "parameter_reference": "param1", "parameter_type": "array" }
See: planNodeMetadata
smart constructor.
Instances
Creates a value of PlanNodeMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pnmAddtional :: Lens' PlanNodeMetadata (HashMap Text JSONValue) Source #
Properties of the object.
PartitionedDml
data PartitionedDml Source #
Message type to initiate a Partitioned DML transaction.
See: partitionedDml
smart constructor.
Instances
partitionedDml :: PartitionedDml Source #
Creates a value of PartitionedDml
with the minimum fields required to make a request.
SetIAMPolicyRequest
data SetIAMPolicyRequest Source #
Request message for `SetIamPolicy` method.
See: setIAMPolicyRequest
smart constructor.
Instances
setIAMPolicyRequest :: SetIAMPolicyRequest Source #
Creates a value of SetIAMPolicyRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
siprPolicy :: Lens' SetIAMPolicyRequest (Maybe Policy) Source #
REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
StatementParamTypes
data StatementParamTypes Source #
It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types.
See: statementParamTypes
smart constructor.
Instances
Creates a value of StatementParamTypes
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
UpdateDatabaseDdlRequest
data UpdateDatabaseDdlRequest Source #
Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future. The server checks that the statements are executable (syntactically valid, name tables that exist, etc.) before enqueueing them, but they may still fail upon later execution (e.g., if a statement from another batch of statements is applied first and it conflicts in some way, or if there is some data-related problem like a `NULL` value in a column to which `NOT NULL` would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled. Each batch of statements is assigned a name which can be used with the Operations API to monitor progress. See the operation_id field for more details.
See: updateDatabaseDdlRequest
smart constructor.
Instances
updateDatabaseDdlRequest :: UpdateDatabaseDdlRequest Source #
Creates a value of UpdateDatabaseDdlRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uddrOperationId :: Lens' UpdateDatabaseDdlRequest (Maybe Text) Source #
If empty, the new update request is assigned an automatically-generated operation ID. Otherwise, `operation_id` is used to construct the name of the resulting Operation. Specifying an explicit operation ID simplifies determining whether the statements were executed in the event that the UpdateDatabaseDdl call is replayed, or the return value is otherwise lost: the database and `operation_id` fields can be combined to form the name of the resulting longrunning.Operation: `/operations/`. `operation_id` should be unique within the database, and must be a valid identifier: `a-z*`. Note that automatically-generated operation IDs always begin with an underscore. If the named operation already exists, UpdateDatabaseDdl returns `ALREADY_EXISTS`.
uddrStatements :: Lens' UpdateDatabaseDdlRequest [Text] Source #
DDL statements to be applied to the database.
Mutation
A modification to one or more Cloud Spanner rows. Mutations can be applied to a Cloud Spanner database by sending them in a Commit call.
See: mutation
smart constructor.
Instances
mReplace :: Lens' Mutation (Maybe Write) Source #
Like insert, except that if the row already exists, it is deleted, and the column values provided are inserted instead. Unlike insert_or_update, this means any values not explicitly written become `NULL`.
mInsert :: Lens' Mutation (Maybe Write) Source #
Insert new rows in a table. If any of the rows already exist, the write or transaction fails with error `ALREADY_EXISTS`.
mInsertOrUpdate :: Lens' Mutation (Maybe Write) Source #
Like insert, except that if the row already exists, then its column values are overwritten with the ones provided. Any column values not explicitly written are preserved.
mDelete :: Lens' Mutation (Maybe Delete') Source #
Delete rows from a table. Succeeds whether or not the named rows were present.
mUpdate :: Lens' Mutation (Maybe Write) Source #
Update existing rows in a table. If any of the rows does not already exist, the transaction fails with error `NOT_FOUND`.
PartitionReadRequest
data PartitionReadRequest Source #
The request for PartitionRead
See: partitionReadRequest
smart constructor.
Instances
partitionReadRequest :: PartitionReadRequest Source #
Creates a value of PartitionReadRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
prrPartitionOptions :: Lens' PartitionReadRequest (Maybe PartitionOptions) Source #
Additional options that affect how many partitions are created.
prrKeySet :: Lens' PartitionReadRequest (Maybe KeySet) Source #
Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. It is not an error for the `key_set` to name rows that do not exist in the database. Read yields nothing for nonexistent rows.
prrTransaction :: Lens' PartitionReadRequest (Maybe TransactionSelector) Source #
Read only snapshot transactions are supported, read/write and single use transactions are not.
prrColumns :: Lens' PartitionReadRequest [Text] Source #
The columns of table to be returned for each row matching this request.
prrIndex :: Lens' PartitionReadRequest (Maybe Text) Source #
If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.
prrTable :: Lens' PartitionReadRequest (Maybe Text) Source #
Required. The name of the table in the database to be read.
ExecuteSQLRequestQueryMode
data ExecuteSQLRequestQueryMode Source #
Used to control the amount of debugging information returned in ResultSetStats. If partition_token is set, query_mode can only be set to QueryMode.NORMAL.
Normal |
|
Plan |
|
ProFile |
|
Instances
ExecuteSQLRequestParamTypes
data ExecuteSQLRequestParamTypes Source #
It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types.
See: executeSQLRequestParamTypes
smart constructor.
Instances
executeSQLRequestParamTypes Source #
Creates a value of ExecuteSQLRequestParamTypes
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Transaction
data Transaction Source #
A transaction.
See: transaction
smart constructor.
Instances
transaction :: Transaction Source #
Creates a value of Transaction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tReadTimestamp :: Lens' Transaction (Maybe UTCTime) Source #
For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see TransactionOptions.ReadOnly.return_read_timestamp. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`.
tId :: Lens' Transaction (Maybe ByteString) Source #
`id` may be used to identify the transaction in subsequent Read, ExecuteSql, Commit, or Rollback calls. Single-use read-only transactions do not have IDs, because single-use transactions do not support multiple requests.
ListSessionsResponse
data ListSessionsResponse Source #
The response for ListSessions.
See: listSessionsResponse
smart constructor.
Instances
listSessionsResponse :: ListSessionsResponse Source #
Creates a value of ListSessionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lsrNextPageToken :: Lens' ListSessionsResponse (Maybe Text) Source #
`next_page_token` can be sent in a subsequent ListSessions call to fetch more of the matching sessions.
lsrSessions :: Lens' ListSessionsResponse [Session] Source #
The list of requested sessions.
ExecuteBatchDmlRequest
data ExecuteBatchDmlRequest Source #
The request for ExecuteBatchDml
See: executeBatchDmlRequest
smart constructor.
Instances
executeBatchDmlRequest :: ExecuteBatchDmlRequest Source #
Creates a value of ExecuteBatchDmlRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ebdrSeqno :: Lens' ExecuteBatchDmlRequest (Maybe Int64) Source #
A per-transaction sequence number used to identify this request. This is used in the same space as the seqno in ExecuteSqlRequest. See more details in ExecuteSqlRequest.
ebdrTransaction :: Lens' ExecuteBatchDmlRequest (Maybe TransactionSelector) Source #
The transaction to use. A ReadWrite transaction is required. Single-use transactions are not supported (to avoid replay). The caller must either supply an existing transaction ID or begin a new transaction.
ebdrStatements :: Lens' ExecuteBatchDmlRequest [Statement] Source #
The list of statements to execute in this batch. Statements are executed serially, such that the effects of statement i are visible to statement i+1. Each statement must be a DML statement. Execution will stop at the first failed statement; the remaining statements will not run. REQUIRES: statements_size() > 0.
StructType
data StructType Source #
`StructType` defines the fields of a STRUCT type.
See: structType
smart constructor.
Instances
structType :: StructType Source #
Creates a value of StructType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
stFields :: Lens' StructType [Field] Source #
The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
DatabaseState
data DatabaseState Source #
Output only. The current database state.
StateUnspecified |
|
Creating |
|
Ready |
|
Instances
Xgafv
V1 error format.
Instances
CommitResponse
data CommitResponse Source #
The response for Commit.
See: commitResponse
smart constructor.
Instances
commitResponse :: CommitResponse Source #
Creates a value of CommitResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
crCommitTimestamp :: Lens' CommitResponse (Maybe UTCTime) Source #
The Cloud Spanner timestamp at which the transaction committed.
Partition
Information returned for each partition returned in a PartitionResponse.
See: partition
smart constructor.
Instances
Eq Partition Source # | |
Data Partition Source # | |
Defined in Network.Google.Spanner.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Partition -> c Partition # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Partition # toConstr :: Partition -> Constr # dataTypeOf :: Partition -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Partition) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Partition) # gmapT :: (forall b. Data b => b -> b) -> Partition -> Partition # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Partition -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Partition -> r # gmapQ :: (forall d. Data d => d -> u) -> Partition -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Partition -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Partition -> m Partition # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Partition -> m Partition # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Partition -> m Partition # | |
Show Partition Source # | |
Generic Partition Source # | |
ToJSON Partition Source # | |
Defined in Network.Google.Spanner.Types.Product | |
FromJSON Partition Source # | |
type Rep Partition Source # | |
Defined in Network.Google.Spanner.Types.Product |
partition :: Partition Source #
Creates a value of Partition
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pPartitionToken :: Lens' Partition (Maybe ByteString) Source #
This token can be passed to Read, StreamingRead, ExecuteSql, or ExecuteStreamingSql requests to restrict the results to those identified by this partition token.
TestIAMPermissionsRequest
data TestIAMPermissionsRequest Source #
Request message for `TestIamPermissions` method.
See: testIAMPermissionsRequest
smart constructor.
Instances
testIAMPermissionsRequest :: TestIAMPermissionsRequest Source #
Creates a value of TestIAMPermissionsRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tiprPermissions :: Lens' TestIAMPermissionsRequest [Text] Source #
REQUIRED: The set of permissions to check for 'resource'. Permissions with wildcards (such as '*', 'spanner.*', 'spanner.instances.*') are not allowed.
PartitionQueryRequestParamTypes
data PartitionQueryRequestParamTypes Source #
It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL query parameters. See the definition of Type for more information about SQL types.
See: partitionQueryRequestParamTypes
smart constructor.
Instances
partitionQueryRequestParamTypes Source #
Creates a value of PartitionQueryRequestParamTypes
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
UpdateInstanceMetadata
data UpdateInstanceMetadata Source #
Metadata type for the operation returned by UpdateInstance.
See: updateInstanceMetadata
smart constructor.
Instances
updateInstanceMetadata :: UpdateInstanceMetadata Source #
Creates a value of UpdateInstanceMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uimStartTime :: Lens' UpdateInstanceMetadata (Maybe UTCTime) Source #
The time at which UpdateInstance request was received.
uimCancelTime :: Lens' UpdateInstanceMetadata (Maybe UTCTime) Source #
The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again.
uimEndTime :: Lens' UpdateInstanceMetadata (Maybe UTCTime) Source #
The time at which this operation failed or was completed successfully.
uimInstance :: Lens' UpdateInstanceMetadata (Maybe Instance) Source #
The desired end state of the update.
PlanNodeExecutionStats
data PlanNodeExecutionStats Source #
The execution statistics associated with the node, contained in a group of key-value pairs. Only present if the plan was returned as a result of a profile query. For example, number of executions, number of rows/time per execution etc.
See: planNodeExecutionStats
smart constructor.
Instances
planNodeExecutionStats Source #
Creates a value of PlanNodeExecutionStats
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pnesAddtional :: Lens' PlanNodeExecutionStats (HashMap Text JSONValue) Source #
Properties of the object.
TestIAMPermissionsResponse
data TestIAMPermissionsResponse Source #
Response message for `TestIamPermissions` method.
See: testIAMPermissionsResponse
smart constructor.
Instances
testIAMPermissionsResponse :: TestIAMPermissionsResponse Source #
Creates a value of TestIAMPermissionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tiamprPermissions :: Lens' TestIAMPermissionsResponse [Text] Source #
A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
PartialResultSet
data PartialResultSet Source #
Partial results from a streaming read or SQL query. Streaming reads and SQL queries better tolerate large result sets, large rows, and large values, but are a little trickier to consume.
See: partialResultSet
smart constructor.
Instances
partialResultSet :: PartialResultSet Source #
Creates a value of PartialResultSet
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
prsResumeToken :: Lens' PartialResultSet (Maybe ByteString) Source #
Streaming calls might be interrupted for a variety of reasons, such as TCP connection loss. If this occurs, the stream of results can be resumed by re-sending the original request and including `resume_token`. Note that executing any other transaction in the same session invalidates the token.
prsValues :: Lens' PartialResultSet [JSONValue] Source #
A streamed result set consists of a stream of values, which might be split into many `PartialResultSet` messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields. Most values are encoded based on type as described here. It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent `PartialResultSet`(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows: * `bool/number/null`: cannot be chunked * `string`: concatenate the strings * `list`: concatenate the lists. If the last element in a list is a `string`, `list`, or `object`, merge it with the first element in the next list by applying these rules recursively. * `object`: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values. Some examples of merging: # Strings are concatenated. "foo", "bar" => "foobar" # Lists of non-strings are concatenated. [2, 3], [4] => [2, 3, 4] # Lists are concatenated, but the last and first elements are merged # because they are strings. ["a", "b"], ["c", "d"] => ["a", "bc", "d"] # Lists are concatenated, but the last and first elements are merged # because they are lists. Recursively, the last and first elements # of the inner lists are merged because they are strings. ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"] # Non-overlapping object fields are combined. {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"} # Overlapping object fields are merged. {"a": "1"}, {"a": "2"} => {"a": "12"} # Examples of merging objects containing lists of strings. {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]} For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following `PartialResultSet`s might be yielded: { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." } This sequence of `PartialResultSet`s encodes two rows, one containing the field value `"Hello"`, and a second containing the field value `"World" = "W" + "orl" + "d"`.
prsStats :: Lens' PartialResultSet (Maybe ResultSetStats) Source #
Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field will also be present in the last response for DML statements.
prsMetadata :: Lens' PartialResultSet (Maybe ResultSetMetadata) Source #
Metadata about the result set, such as row type information. Only present in the first response.
prsChunkedValue :: Lens' PartialResultSet (Maybe Bool) Source #
If true, then the final value in values is chunked, and must be combined with more values from subsequent `PartialResultSet`s to obtain a complete field value.
Policy
Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike'example.com", "group:admins'example.com", "domain:google.com", "serviceAccount:my-other-app'appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean'example.com"] } ] } **YAML Example** bindings: - members: - user:mike'example.com - group:admins'example.com - domain:google.com - serviceAccount:my-other-app'appspot.gserviceaccount.com role: roles/owner - members: - user:sean'example.com role: roles/viewer For a description of IAM and its features, see the IAM developer's guide.
See: policy
smart constructor.
Instances
Eq Policy Source # | |
Data Policy Source # | |
Defined in Network.Google.Spanner.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Policy -> c Policy # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Policy # toConstr :: Policy -> Constr # dataTypeOf :: Policy -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Policy) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Policy) # gmapT :: (forall b. Data b => b -> b) -> Policy -> Policy # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Policy -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Policy -> r # gmapQ :: (forall d. Data d => d -> u) -> Policy -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Policy -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Policy -> m Policy # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Policy -> m Policy # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Policy -> m Policy # | |
Show Policy Source # | |
Generic Policy Source # | |
ToJSON Policy Source # | |
Defined in Network.Google.Spanner.Types.Product | |
FromJSON Policy Source # | |
type Rep Policy Source # | |
Defined in Network.Google.Spanner.Types.Product type Rep Policy = D1 (MetaData "Policy" "Network.Google.Spanner.Types.Product" "gogol-spanner-0.5.0-EbKAd7GSsmo9VdnPLfZZzz" False) (C1 (MetaCons "Policy'" PrefixI True) (S1 (MetaSel (Just "_pEtag") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bytes)) :*: (S1 (MetaSel (Just "_pVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_pBindings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Binding]))))) |
pEtag :: Lens' Policy (Maybe ByteString) Source #
`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
pBindings :: Lens' Policy [Binding] Source #
Associates a list of `members` to a `role`. `bindings` with no members will result in an error.
CreateDatabaseRequest
data CreateDatabaseRequest Source #
The request for CreateDatabase.
See: createDatabaseRequest
smart constructor.
Instances
createDatabaseRequest :: CreateDatabaseRequest Source #
Creates a value of CreateDatabaseRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdrExtraStatements :: Lens' CreateDatabaseRequest [Text] Source #
An optional list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created.
cdrCreateStatement :: Lens' CreateDatabaseRequest (Maybe Text) Source #
Required. A `CREATE DATABASE` statement, which specifies the ID of the new database. The database ID must conform to the regular expression `a-z*[a-z0-9]` and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (`` ` ``).
ExecuteSQLRequest
data ExecuteSQLRequest Source #
The request for ExecuteSql and ExecuteStreamingSql.
See: executeSQLRequest
smart constructor.
Instances
executeSQLRequest :: ExecuteSQLRequest Source #
Creates a value of ExecuteSQLRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
esqlrParamTypes :: Lens' ExecuteSQLRequest (Maybe ExecuteSQLRequestParamTypes) Source #
It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types.
esqlrResumeToken :: Lens' ExecuteSQLRequest (Maybe ByteString) Source #
If this request is resuming a previously interrupted SQL statement execution, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new SQL statement execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token.
esqlrSeqno :: Lens' ExecuteSQLRequest (Maybe Int64) Source #
A per-transaction sequence number used to identify this request. This makes each request idempotent such that if the request is received multiple times, at most one will succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution. Required for DML statements. Ignored for queries.
esqlrParams :: Lens' ExecuteSQLRequest (Maybe ExecuteSQLRequestParams) Source #
The SQL string can contain parameter placeholders. A parameter placeholder consists of `'''` followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > 'msg_id AND id < 'msg_id + 100"` It is an error to execute an SQL statement with unbound parameters. Parameter values are specified using `params`, which is a JSON object whose keys are parameter names, and whose values are the corresponding parameter values.
esqlrTransaction :: Lens' ExecuteSQLRequest (Maybe TransactionSelector) Source #
The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency. The transaction to use. For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency. Standard DML statements require a ReadWrite transaction. Single-use transactions are not supported (to avoid replay). The caller must either supply an existing transaction ID or begin a new transaction. Partitioned DML requires an existing PartitionedDml transaction ID.
esqlrPartitionToken :: Lens' ExecuteSQLRequest (Maybe ByteString) Source #
If present, results will be restricted to the specified partition previously created using PartitionQuery(). There must be an exact match for the values of fields common to this message and the PartitionQueryRequest message used to create this partition_token.
esqlrQueryMode :: Lens' ExecuteSQLRequest (Maybe ExecuteSQLRequestQueryMode) Source #
Used to control the amount of debugging information returned in ResultSetStats. If partition_token is set, query_mode can only be set to QueryMode.NORMAL.
CommitRequest
data CommitRequest Source #
The request for Commit.
See: commitRequest
smart constructor.
Instances
commitRequest :: CommitRequest Source #
Creates a value of CommitRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
crMutations :: Lens' CommitRequest [Mutation] Source #
The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.
crTransactionId :: Lens' CommitRequest (Maybe ByteString) Source #
Commit a previously-started transaction.
crSingleUseTransaction :: Lens' CommitRequest (Maybe TransactionOptions) Source #
Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the `CommitRequest` is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead.
Type
`Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query.
See: type'
smart constructor.
Instances
Eq Type Source # | |
Data Type Source # | |
Defined in Network.Google.Spanner.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Type -> c Type # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Type # dataTypeOf :: Type -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Type) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Type) # gmapT :: (forall b. Data b => b -> b) -> Type -> Type # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Type -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Type -> r # gmapQ :: (forall d. Data d => d -> u) -> Type -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Type -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Type -> m Type # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Type -> m Type # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Type -> m Type # | |
Show Type Source # | |
Generic Type Source # | |
ToJSON Type Source # | |
Defined in Network.Google.Spanner.Types.Product | |
FromJSON Type Source # | |
type Rep Type Source # | |
Defined in Network.Google.Spanner.Types.Product type Rep Type = D1 (MetaData "Type" "Network.Google.Spanner.Types.Product" "gogol-spanner-0.5.0-EbKAd7GSsmo9VdnPLfZZzz" False) (C1 (MetaCons "Type'" PrefixI True) (S1 (MetaSel (Just "_tArrayElementType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Type)) :*: (S1 (MetaSel (Just "_tStructType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe StructType)) :*: S1 (MetaSel (Just "_tCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe TypeCode))))) |
Creates a value of Type
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tArrayElementType :: Lens' Type (Maybe Type) Source #
If code == ARRAY, then `array_element_type` is the type of the array elements.
tStructType :: Lens' Type (Maybe StructType) Source #
If code == STRUCT, then `struct_type` provides type information for the struct's fields.
CreateInstanceMetadata
data CreateInstanceMetadata Source #
Metadata type for the operation returned by CreateInstance.
See: createInstanceMetadata
smart constructor.
Instances
createInstanceMetadata :: CreateInstanceMetadata Source #
Creates a value of CreateInstanceMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cimStartTime :: Lens' CreateInstanceMetadata (Maybe UTCTime) Source #
The time at which the CreateInstance request was received.
cimCancelTime :: Lens' CreateInstanceMetadata (Maybe UTCTime) Source #
The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again.
cimEndTime :: Lens' CreateInstanceMetadata (Maybe UTCTime) Source #
The time at which this operation failed or was completed successfully.
cimInstance :: Lens' CreateInstanceMetadata (Maybe Instance) Source #
The instance being created.
KeyRange
KeyRange represents a range of rows in a table or index. A range has a start key and an end key. These keys can be open or closed, indicating if the range includes rows with that key. Keys are represented by lists, where the ith value in the list corresponds to the ith component of the table or index primary key. Individual values are encoded as described here. For example, consider the following table definition: CREATE TABLE UserEvents ( UserName STRING(MAX), EventDate STRING(10) ) PRIMARY KEY(UserName, EventDate); The following keys name rows in this table: "Bob", "2014-09-23" Since the `UserEvents` table's `PRIMARY KEY` clause names two columns, each `UserEvents` key has two elements; the first is the `UserName`, and the second is the `EventDate`. Key ranges with multiple components are interpreted lexicographically by component using the table or index key's declared sort order. For example, the following range returns all events for user `"Bob"` that occurred in the year 2015: "start_closed": ["Bob", "2015-01-01"] "end_closed": ["Bob", "2015-12-31"] Start and end keys can omit trailing key components. This affects the inclusion and exclusion of rows that exactly match the provided key components: if the key is closed, then rows that exactly match the provided components are included; if the key is open, then rows that exactly match are not included. For example, the following range includes all events for `"Bob"` that occurred during and after the year 2000: "start_closed": ["Bob", "2000-01-01"] "end_closed": ["Bob"] The next example retrieves all events for `"Bob"`: "start_closed": ["Bob"] "end_closed": ["Bob"] To retrieve events before the year 2000: "start_closed": ["Bob"] "end_open": ["Bob", "2000-01-01"] The following range includes all rows in the table: "start_closed": [] "end_closed": [] This range returns all users whose `UserName` begins with any character from A to C: "start_closed": ["A"] "end_open": ["D"] This range returns all users whose `UserName` begins with B: "start_closed": ["B"] "end_open": ["C"] Key ranges honor column sort order. For example, suppose a table is defined as follows: CREATE TABLE DescendingSortedTable { Key INT64, ... ) PRIMARY KEY(Key DESC); The following range retrieves all rows with key values between 1 and 100 inclusive: "start_closed": ["100"] "end_closed": ["1"] Note that 100 is passed as the start, and 1 is passed as the end, because `Key` is a descending column in the schema.
See: keyRange
smart constructor.
Instances
Eq KeyRange Source # | |
Data KeyRange Source # | |
Defined in Network.Google.Spanner.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> KeyRange -> c KeyRange # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c KeyRange # toConstr :: KeyRange -> Constr # dataTypeOf :: KeyRange -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c KeyRange) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c KeyRange) # gmapT :: (forall b. Data b => b -> b) -> KeyRange -> KeyRange # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> KeyRange -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> KeyRange -> r # gmapQ :: (forall d. Data d => d -> u) -> KeyRange -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> KeyRange -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> KeyRange -> m KeyRange # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> KeyRange -> m KeyRange # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> KeyRange -> m KeyRange # | |
Show KeyRange Source # | |
Generic KeyRange Source # | |
ToJSON KeyRange Source # | |
Defined in Network.Google.Spanner.Types.Product | |
FromJSON KeyRange Source # | |
type Rep KeyRange Source # | |
Defined in Network.Google.Spanner.Types.Product type Rep KeyRange = D1 (MetaData "KeyRange" "Network.Google.Spanner.Types.Product" "gogol-spanner-0.5.0-EbKAd7GSsmo9VdnPLfZZzz" False) (C1 (MetaCons "KeyRange'" PrefixI True) ((S1 (MetaSel (Just "_krStartClosed") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [JSONValue])) :*: S1 (MetaSel (Just "_krEndOpen") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [JSONValue]))) :*: (S1 (MetaSel (Just "_krStartOpen") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [JSONValue])) :*: S1 (MetaSel (Just "_krEndClosed") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [JSONValue]))))) |
Creates a value of KeyRange
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
krStartClosed :: Lens' KeyRange [JSONValue] Source #
If the start is closed, then the range includes all rows whose first `len(start_closed)` key columns exactly match `start_closed`.
krEndOpen :: Lens' KeyRange [JSONValue] Source #
If the end is open, then the range excludes rows whose first `len(end_open)` key columns exactly match `end_open`.
krStartOpen :: Lens' KeyRange [JSONValue] Source #
If the start is open, then the range excludes rows whose first `len(start_open)` key columns exactly match `start_open`.
krEndClosed :: Lens' KeyRange [JSONValue] Source #
If the end is closed, then the range includes all rows whose first `len(end_closed)` key columns exactly match `end_closed`.
OperationMetadata
data OperationMetadata Source #
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
See: operationMetadata
smart constructor.
Instances
Creates a value of OperationMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
omAddtional :: Lens' OperationMetadata (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
InstanceConfig
data InstanceConfig Source #
A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.
See: instanceConfig
smart constructor.
Instances
instanceConfig :: InstanceConfig Source #
Creates a value of InstanceConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
icName :: Lens' InstanceConfig (Maybe Text) Source #
A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`
icDisplayName :: Lens' InstanceConfig (Maybe Text) Source #
The name of this instance configuration as it appears in UIs.
ResultSet
Results from Read or ExecuteSql.
See: resultSet
smart constructor.
Instances
Eq ResultSet Source # | |
Data ResultSet Source # | |
Defined in Network.Google.Spanner.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ResultSet -> c ResultSet # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ResultSet # toConstr :: ResultSet -> Constr # dataTypeOf :: ResultSet -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ResultSet) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ResultSet) # gmapT :: (forall b. Data b => b -> b) -> ResultSet -> ResultSet # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ResultSet -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ResultSet -> r # gmapQ :: (forall d. Data d => d -> u) -> ResultSet -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ResultSet -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ResultSet -> m ResultSet # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ResultSet -> m ResultSet # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ResultSet -> m ResultSet # | |
Show ResultSet Source # | |
Generic ResultSet Source # | |
ToJSON ResultSet Source # | |
Defined in Network.Google.Spanner.Types.Product | |
FromJSON ResultSet Source # | |
type Rep ResultSet Source # | |
Defined in Network.Google.Spanner.Types.Product type Rep ResultSet = D1 (MetaData "ResultSet" "Network.Google.Spanner.Types.Product" "gogol-spanner-0.5.0-EbKAd7GSsmo9VdnPLfZZzz" False) (C1 (MetaCons "ResultSet'" PrefixI True) (S1 (MetaSel (Just "_rsStats") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ResultSetStats)) :*: (S1 (MetaSel (Just "_rsRows") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [[JSONValue]])) :*: S1 (MetaSel (Just "_rsMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ResultSetMetadata))))) |
resultSet :: ResultSet Source #
Creates a value of ResultSet
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rsStats :: Lens' ResultSet (Maybe ResultSetStats) Source #
Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields may or may not be populated, based on the ExecuteSqlRequest.query_mode.
rsRows :: Lens' ResultSet [[JSONValue]] Source #
Each element in `rows` is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here.
rsMetadata :: Lens' ResultSet (Maybe ResultSetMetadata) Source #
Metadata about the result set, such as row type information.
SessionLabels
data SessionLabels Source #
The labels for the session. * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given session. See https://goo.gl/xmQnxf for more information on and examples of labels.
See: sessionLabels
smart constructor.
Instances
Creates a value of SessionLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ListInstancesResponse
data ListInstancesResponse Source #
The response for ListInstances.
See: listInstancesResponse
smart constructor.
Instances
listInstancesResponse :: ListInstancesResponse Source #
Creates a value of ListInstancesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lirNextPageToken :: Lens' ListInstancesResponse (Maybe Text) Source #
`next_page_token` can be sent in a subsequent ListInstances call to fetch more of the matching instances.
lirInstances :: Lens' ListInstancesResponse [Instance] Source #
The list of requested instances.
ReadRequest
data ReadRequest Source #
The request for Read and StreamingRead.
See: readRequest
smart constructor.
Instances
readRequest :: ReadRequest Source #
Creates a value of ReadRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrResumeToken :: Lens' ReadRequest (Maybe ByteString) Source #
If this request is resuming a previously interrupted read, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token.
rrKeySet :: Lens' ReadRequest (Maybe KeySet) Source #
Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty). If the partition_token field is not empty, rows will be yielded in an unspecified order. It is not an error for the `key_set` to name rows that do not exist in the database. Read yields nothing for nonexistent rows.
rrTransaction :: Lens' ReadRequest (Maybe TransactionSelector) Source #
The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.
rrColumns :: Lens' ReadRequest [Text] Source #
The columns of table to be returned for each row matching this request.
rrLimit :: Lens' ReadRequest (Maybe Int64) Source #
If greater than zero, only the first `limit` rows are yielded. If `limit` is zero, the default is no limit. A limit cannot be specified if `partition_token` is set.
rrIndex :: Lens' ReadRequest (Maybe Text) Source #
If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.
rrTable :: Lens' ReadRequest (Maybe Text) Source #
Required. The name of the table in the database to be read.
rrPartitionToken :: Lens' ReadRequest (Maybe ByteString) Source #
If present, results will be restricted to the specified partition previously created using PartitionRead(). There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token.
InstanceState
data InstanceState Source #
Output only. The current instance state. For CreateInstance, the state must be either omitted or set to `CREATING`. For UpdateInstance, the state must be either omitted or set to `READY`.
ISStateUnspecified |
|
ISCreating |
|
ISReady |
|
Instances
Session
A session in the Cloud Spanner API.
See: session
smart constructor.
Instances
Eq Session Source # | |
Data Session Source # | |
Defined in Network.Google.Spanner.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Session -> c Session # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Session # toConstr :: Session -> Constr # dataTypeOf :: Session -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Session) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Session) # gmapT :: (forall b. Data b => b -> b) -> Session -> Session # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Session -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Session -> r # gmapQ :: (forall d. Data d => d -> u) -> Session -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Session -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Session -> m Session # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Session -> m Session # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Session -> m Session # | |
Show Session Source # | |
Generic Session Source # | |
ToJSON Session Source # | |
Defined in Network.Google.Spanner.Types.Product | |
FromJSON Session Source # | |
type Rep Session Source # | |
Defined in Network.Google.Spanner.Types.Product type Rep Session = D1 (MetaData "Session" "Network.Google.Spanner.Types.Product" "gogol-spanner-0.5.0-EbKAd7GSsmo9VdnPLfZZzz" False) (C1 (MetaCons "Session'" PrefixI True) ((S1 (MetaSel (Just "_sApproximateLastUseTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime')) :*: S1 (MetaSel (Just "_sName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_sLabels") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SessionLabels)) :*: S1 (MetaSel (Just "_sCreateTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime'))))) |
Creates a value of Session
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sApproximateLastUseTime :: Lens' Session (Maybe UTCTime) Source #
Output only. The approximate timestamp when the session is last used. It is typically earlier than the actual last use time.
sName :: Lens' Session (Maybe Text) Source #
The name of the session. This is always system-assigned; values provided when creating a session are ignored.
sLabels :: Lens' Session (Maybe SessionLabels) Source #
The labels for the session. * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given session. See https://goo.gl/xmQnxf for more information on and examples of labels.
sCreateTime :: Lens' Session (Maybe UTCTime) Source #
Output only. The timestamp when the session is created.
OperationResponse
data OperationResponse Source #
The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
See: operationResponse
smart constructor.
Instances
Creates a value of OperationResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
orAddtional :: Lens' OperationResponse (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
ReadOnly
Message type to initiate a read-only transaction.
See: readOnly
smart constructor.
Instances
Creates a value of ReadOnly
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
roReadTimestamp :: Lens' ReadOnly (Maybe UTCTime) Source #
Executes all reads at the given timestamp. Unlike other modes, reads at a specific timestamp are repeatable; the same read at the same timestamp always returns the same data. If the timestamp is in the future, the read will block until the specified timestamp, modulo the read's deadline. Useful for large scale consistent reads such as mapreduces, or for coordinating many reads against a consistent snapshot of the data. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`.
roExactStaleness :: Lens' ReadOnly (Maybe Scientific) Source #
Executes all reads at a timestamp that is `exact_staleness` old. The timestamp is chosen soon after the read is started. Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps. Useful for reading at nearby replicas without the distributed timestamp negotiation overhead of `max_staleness`.
roMaxStaleness :: Lens' ReadOnly (Maybe Scientific) Source #
Read data at a timestamp >= `NOW - max_staleness` seconds. Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps. Useful for reading the freshest data available at a nearby replica, while bounding the possible staleness if the local replica has fallen behind. Note that this option can only be used in single-use transactions.
roStrong :: Lens' ReadOnly (Maybe Bool) Source #
Read at a timestamp where all previously committed transactions are visible.
roMinReadTimestamp :: Lens' ReadOnly (Maybe UTCTime) Source #
Executes all reads at a timestamp >= `min_read_timestamp`. This is useful for requesting fresher data than some previous read, or data that is fresh enough to observe the effects of some previously committed transaction whose timestamp is known. Note that this option can only be used in single-use transactions. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`.
roReturnReadTimestamp :: Lens' ReadOnly (Maybe Bool) Source #
If true, the Cloud Spanner-selected read timestamp is included in the Transaction message that describes the transaction.
ResultSetMetadata
data ResultSetMetadata Source #
Metadata about a ResultSet or PartialResultSet.
See: resultSetMetadata
smart constructor.
Instances
resultSetMetadata :: ResultSetMetadata Source #
Creates a value of ResultSetMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rsmRowType :: Lens' ResultSetMetadata (Maybe StructType) Source #
Indicates the field names and types for the rows in the result set. For example, a SQL query like `"SELECT UserId, UserName FROM Users"` could return a `row_type` value like: "fields": [ { "name": "UserId", "type": { "code": "INT64" } }, { "name": "UserName", "type": { "code": "STRING" } }, ]
rsmTransaction :: Lens' ResultSetMetadata (Maybe Transaction) Source #
If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here.
Delete'
Arguments to delete operations.
See: delete'
smart constructor.
Instances
Eq Delete' Source # | |
Data Delete' Source # | |
Defined in Network.Google.Spanner.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Delete' -> c Delete' # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Delete' # toConstr :: Delete' -> Constr # dataTypeOf :: Delete' -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Delete') # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Delete') # gmapT :: (forall b. Data b => b -> b) -> Delete' -> Delete' # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Delete' -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Delete' -> r # gmapQ :: (forall d. Data d => d -> u) -> Delete' -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Delete' -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Delete' -> m Delete' # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Delete' -> m Delete' # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Delete' -> m Delete' # | |
Show Delete' Source # | |
Generic Delete' Source # | |
ToJSON Delete' Source # | |
Defined in Network.Google.Spanner.Types.Product | |
FromJSON Delete' Source # | |
type Rep Delete' Source # | |
Defined in Network.Google.Spanner.Types.Product type Rep Delete' = D1 (MetaData "Delete'" "Network.Google.Spanner.Types.Product" "gogol-spanner-0.5.0-EbKAd7GSsmo9VdnPLfZZzz" False) (C1 (MetaCons "Delete''" PrefixI True) (S1 (MetaSel (Just "_dKeySet") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe KeySet)) :*: S1 (MetaSel (Just "_dTable") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) |
dKeySet :: Lens' Delete' (Maybe KeySet) Source #
Required. The primary keys of the rows within table to delete. Delete is idempotent. The transaction will succeed even if some or all rows do not exist.
UpdateInstanceRequest
data UpdateInstanceRequest Source #
The request for UpdateInstance.
See: updateInstanceRequest
smart constructor.
Instances
updateInstanceRequest :: UpdateInstanceRequest Source #
Creates a value of UpdateInstanceRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uirFieldMask :: Lens' UpdateInstanceRequest (Maybe GFieldMask) Source #
Required. A mask specifying which fields in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.instance] should be updated. The field mask must always be specified; this prevents any future fields in [][google.spanner.admin.instance.v1.Instance] from being erased accidentally by clients that do not know about them.
uirInstance :: Lens' UpdateInstanceRequest (Maybe Instance) Source #
Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be included.
ResultSetStatsQueryStats
data ResultSetStatsQueryStats Source #
Aggregated statistics from the execution of the query. Only present when the query is profiled. For example, a query could return the statistics as follows: { "rows_returned": "3", "elapsed_time": "1.22 secs", "cpu_time": "1.19 secs" }
See: resultSetStatsQueryStats
smart constructor.
Instances
resultSetStatsQueryStats Source #
Creates a value of ResultSetStatsQueryStats
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rssqsAddtional :: Lens' ResultSetStatsQueryStats (HashMap Text JSONValue) Source #
Properties of the object.
StatementParams
data StatementParams Source #
The DML string can contain parameter placeholders. A parameter placeholder consists of `'''` followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > 'msg_id AND id < 'msg_id + 100"` It is an error to execute an SQL statement with unbound parameters. Parameter values are specified using `params`, which is a JSON object whose keys are parameter names, and whose values are the corresponding parameter values.
See: statementParams
smart constructor.
Instances
Creates a value of StatementParams
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
spAddtional :: Lens' StatementParams (HashMap Text JSONValue) Source #
Properties of the object.
TransactionSelector
data TransactionSelector Source #
This message is used to select the transaction in which a Read or ExecuteSql call runs. See TransactionOptions for more information about transactions.
See: transactionSelector
smart constructor.
Instances
transactionSelector :: TransactionSelector Source #
Creates a value of TransactionSelector
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tsBegin :: Lens' TransactionSelector (Maybe TransactionOptions) Source #
Begin a new transaction and execute this read or SQL query in it. The transaction ID of the new transaction is returned in ResultSetMetadata.transaction, which is a Transaction.
tsId :: Lens' TransactionSelector (Maybe ByteString) Source #
Execute the read or SQL query in a previously-started transaction.
tsSingleUse :: Lens' TransactionSelector (Maybe TransactionOptions) Source #
Execute the read or SQL query in a temporary transaction. This is the most efficient way to execute a transaction that consists of a single SQL query.
ListInstanceConfigsResponse
data ListInstanceConfigsResponse Source #
The response for ListInstanceConfigs.
See: listInstanceConfigsResponse
smart constructor.
Instances
listInstanceConfigsResponse :: ListInstanceConfigsResponse Source #
Creates a value of ListInstanceConfigsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
licrNextPageToken :: Lens' ListInstanceConfigsResponse (Maybe Text) Source #
`next_page_token` can be sent in a subsequent ListInstanceConfigs call to fetch more of the matching instance configurations.
licrInstanceConfigs :: Lens' ListInstanceConfigsResponse [InstanceConfig] Source #
The list of requested instance configurations.
Binding
Associates `members` with a `role`.
See: binding
smart constructor.
Instances
Eq Binding Source # | |
Data Binding Source # | |
Defined in Network.Google.Spanner.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Binding -> c Binding # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Binding # toConstr :: Binding -> Constr # dataTypeOf :: Binding -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Binding) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Binding) # gmapT :: (forall b. Data b => b -> b) -> Binding -> Binding # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Binding -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Binding -> r # gmapQ :: (forall d. Data d => d -> u) -> Binding -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Binding -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Binding -> m Binding # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Binding -> m Binding # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Binding -> m Binding # | |
Show Binding Source # | |
Generic Binding Source # | |
ToJSON Binding Source # | |
Defined in Network.Google.Spanner.Types.Product | |
FromJSON Binding Source # | |
type Rep Binding Source # | |
Defined in Network.Google.Spanner.Types.Product type Rep Binding = D1 (MetaData "Binding" "Network.Google.Spanner.Types.Product" "gogol-spanner-0.5.0-EbKAd7GSsmo9VdnPLfZZzz" False) (C1 (MetaCons "Binding'" PrefixI True) (S1 (MetaSel (Just "_bMembers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 (MetaSel (Just "_bRole") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_bCondition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Expr))))) |
Creates a value of Binding
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bMembers :: Lens' Binding [Text] Source #
Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice'gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app'appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins'example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
bRole :: Lens' Binding (Maybe Text) Source #
Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
bCondition :: Lens' Binding (Maybe Expr) Source #
Unimplemented. The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
PartitionResponse
data PartitionResponse Source #
The response for PartitionQuery or PartitionRead
See: partitionResponse
smart constructor.
Instances
partitionResponse :: PartitionResponse Source #
Creates a value of PartitionResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
prPartitions :: Lens' PartitionResponse [Partition] Source #
Partitions created by this request.
prTransaction :: Lens' PartitionResponse (Maybe Transaction) Source #
Transaction created by this request.
PartitionQueryRequest
data PartitionQueryRequest Source #
The request for PartitionQuery
See: partitionQueryRequest
smart constructor.
Instances
partitionQueryRequest :: PartitionQueryRequest Source #
Creates a value of PartitionQueryRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pqrParamTypes :: Lens' PartitionQueryRequest (Maybe PartitionQueryRequestParamTypes) Source #
It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL query parameters. See the definition of Type for more information about SQL types.
pqrPartitionOptions :: Lens' PartitionQueryRequest (Maybe PartitionOptions) Source #
Additional options that affect how many partitions are created.
pqrParams :: Lens' PartitionQueryRequest (Maybe PartitionQueryRequestParams) Source #
The SQL query string can contain parameter placeholders. A parameter placeholder consists of `'''` followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > 'msg_id AND id < 'msg_id + 100"` It is an error to execute an SQL query with unbound parameters. Parameter values are specified using `params`, which is a JSON object whose keys are parameter names, and whose values are the corresponding parameter values.
pqrTransaction :: Lens' PartitionQueryRequest (Maybe TransactionSelector) Source #
Read only snapshot transactions are supported, read/write and single use transactions are not.
pqrSQL :: Lens' PartitionQueryRequest (Maybe Text) Source #
The query request to generate partitions for. The request will fail if the query is not root partitionable. The query plan of a root partitionable query has a single distributed union operator. A distributed union operator conceptually divides one or more tables into multiple splits, remotely evaluates a subquery independently on each split, and then unions all results. This must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations.
QueryPlan
Contains an ordered list of nodes appearing in the query plan.
See: queryPlan
smart constructor.
Instances
Eq QueryPlan Source # | |
Data QueryPlan Source # | |
Defined in Network.Google.Spanner.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> QueryPlan -> c QueryPlan # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c QueryPlan # toConstr :: QueryPlan -> Constr # dataTypeOf :: QueryPlan -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c QueryPlan) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c QueryPlan) # gmapT :: (forall b. Data b => b -> b) -> QueryPlan -> QueryPlan # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> QueryPlan -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> QueryPlan -> r # gmapQ :: (forall d. Data d => d -> u) -> QueryPlan -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> QueryPlan -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> QueryPlan -> m QueryPlan # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> QueryPlan -> m QueryPlan # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> QueryPlan -> m QueryPlan # | |
Show QueryPlan Source # | |
Generic QueryPlan Source # | |
ToJSON QueryPlan Source # | |
Defined in Network.Google.Spanner.Types.Product | |
FromJSON QueryPlan Source # | |
type Rep QueryPlan Source # | |
Defined in Network.Google.Spanner.Types.Product |
queryPlan :: QueryPlan Source #
Creates a value of QueryPlan
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qpPlanNodes :: Lens' QueryPlan [PlanNode] Source #
The nodes in the query plan. Plan nodes are returned in pre-order starting with the plan root. Each PlanNode's `id` corresponds to its index in `plan_nodes`.
Instance
An isolated set of Cloud Spanner resources on which databases can be hosted.
See: instance'
smart constructor.
Instances
instance' :: Instance Source #
Creates a value of Instance
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iState :: Lens' Instance (Maybe InstanceState) Source #
Output only. The current instance state. For CreateInstance, the state must be either omitted or set to `CREATING`. For UpdateInstance, the state must be either omitted or set to `READY`.
iConfig :: Lens' Instance (Maybe Text) Source #
Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs.
iNodeCount :: Lens' Instance (Maybe Int32) Source #
Required. The number of nodes allocated to this instance. This may be zero in API responses for instances that are not yet in state `READY`. See the documentation for more information about nodes.
iName :: Lens' Instance (Maybe Text) Source #
Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length.
iDisplayName :: Lens' Instance (Maybe Text) Source #
Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
iLabels :: Lens' Instance (Maybe InstanceLabels) Source #
Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release.