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

Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.PartitionQuery

Contents

REST Resource
Creating a Request
Request Lenses

Description

Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the query, and the whole operation must be restarted from the beginning.

See: Cloud Spanner API Reference for spanner.projects.instances.databases.sessions.partitionQuery.

Synopsis

type ProjectsInstancesDatabasesSessionsPartitionQueryResource = "v1" :> (CaptureMode "session" "partitionQuery" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] PartitionQueryRequest :> Post '[JSON] PartitionResponse))))))))
projectsInstancesDatabasesSessionsPartitionQuery :: PartitionQueryRequest -> Text -> ProjectsInstancesDatabasesSessionsPartitionQuery
data ProjectsInstancesDatabasesSessionsPartitionQuery
pidspqXgafv :: Lens' ProjectsInstancesDatabasesSessionsPartitionQuery (Maybe Xgafv)
pidspqUploadProtocol :: Lens' ProjectsInstancesDatabasesSessionsPartitionQuery (Maybe Text)
pidspqAccessToken :: Lens' ProjectsInstancesDatabasesSessionsPartitionQuery (Maybe Text)
pidspqUploadType :: Lens' ProjectsInstancesDatabasesSessionsPartitionQuery (Maybe Text)
pidspqPayload :: Lens' ProjectsInstancesDatabasesSessionsPartitionQuery PartitionQueryRequest
pidspqSession :: Lens' ProjectsInstancesDatabasesSessionsPartitionQuery Text
pidspqCallback :: Lens' ProjectsInstancesDatabasesSessionsPartitionQuery (Maybe Text)

REST Resource

type ProjectsInstancesDatabasesSessionsPartitionQueryResource = "v1" :> (CaptureMode "session" "partitionQuery" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] PartitionQueryRequest :> Post '[JSON] PartitionResponse)))))))) Source #

A resource alias for spanner.projects.instances.databases.sessions.partitionQuery method which the ProjectsInstancesDatabasesSessionsPartitionQuery request conforms to.

Creating a Request

projectsInstancesDatabasesSessionsPartitionQuery Source #

Arguments

:: PartitionQueryRequest	`pidspqPayload`
-> Text	`pidspqSession`
-> ProjectsInstancesDatabasesSessionsPartitionQuery

Creates a value of ProjectsInstancesDatabasesSessionsPartitionQuery with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data ProjectsInstancesDatabasesSessionsPartitionQuery Source #

Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the query, and the whole operation must be restarted from the beginning.

See: projectsInstancesDatabasesSessionsPartitionQuery smart constructor.

Instances

Eq ProjectsInstancesDatabasesSessionsPartitionQuery Source #
Instance details Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.PartitionQuery Methods (==) :: ProjectsInstancesDatabasesSessionsPartitionQuery -> ProjectsInstancesDatabasesSessionsPartitionQuery -> Bool # (/=) :: ProjectsInstancesDatabasesSessionsPartitionQuery -> ProjectsInstancesDatabasesSessionsPartitionQuery -> Bool #
Data ProjectsInstancesDatabasesSessionsPartitionQuery Source #
Instance details Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.PartitionQuery Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsInstancesDatabasesSessionsPartitionQuery -> c ProjectsInstancesDatabasesSessionsPartitionQuery # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsInstancesDatabasesSessionsPartitionQuery # toConstr :: ProjectsInstancesDatabasesSessionsPartitionQuery -> Constr # dataTypeOf :: ProjectsInstancesDatabasesSessionsPartitionQuery -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsInstancesDatabasesSessionsPartitionQuery) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsInstancesDatabasesSessionsPartitionQuery) # gmapT :: (forall b. Data b => b -> b) -> ProjectsInstancesDatabasesSessionsPartitionQuery -> ProjectsInstancesDatabasesSessionsPartitionQuery # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsInstancesDatabasesSessionsPartitionQuery -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsInstancesDatabasesSessionsPartitionQuery -> r # gmapQ :: (forall d. Data d => d -> u) -> ProjectsInstancesDatabasesSessionsPartitionQuery -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsInstancesDatabasesSessionsPartitionQuery -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsInstancesDatabasesSessionsPartitionQuery -> m ProjectsInstancesDatabasesSessionsPartitionQuery # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsInstancesDatabasesSessionsPartitionQuery -> m ProjectsInstancesDatabasesSessionsPartitionQuery # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsInstancesDatabasesSessionsPartitionQuery -> m ProjectsInstancesDatabasesSessionsPartitionQuery #
Show ProjectsInstancesDatabasesSessionsPartitionQuery Source #
Instance details Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.PartitionQuery Methods showsPrec :: Int -> ProjectsInstancesDatabasesSessionsPartitionQuery -> ShowS # show :: ProjectsInstancesDatabasesSessionsPartitionQuery -> String # showList :: [ProjectsInstancesDatabasesSessionsPartitionQuery] -> ShowS #
Generic ProjectsInstancesDatabasesSessionsPartitionQuery Source #
Instance details Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.PartitionQuery Associated Types type Rep ProjectsInstancesDatabasesSessionsPartitionQuery :: Type -> Type # Methods from :: ProjectsInstancesDatabasesSessionsPartitionQuery -> Rep ProjectsInstancesDatabasesSessionsPartitionQuery x # to :: Rep ProjectsInstancesDatabasesSessionsPartitionQuery x -> ProjectsInstancesDatabasesSessionsPartitionQuery #
GoogleRequest ProjectsInstancesDatabasesSessionsPartitionQuery Source #
Instance details Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.PartitionQuery Associated Types type Rs ProjectsInstancesDatabasesSessionsPartitionQuery :: Type # type Scopes ProjectsInstancesDatabasesSessionsPartitionQuery :: [Symbol] # Methods requestClient :: ProjectsInstancesDatabasesSessionsPartitionQuery -> GClient (Rs ProjectsInstancesDatabasesSessionsPartitionQuery) #
type Rep ProjectsInstancesDatabasesSessionsPartitionQuery Source #
Instance details Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.PartitionQuery type Rep ProjectsInstancesDatabasesSessionsPartitionQuery = D1 (MetaData "ProjectsInstancesDatabasesSessionsPartitionQuery" "Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.PartitionQuery" "gogol-spanner-0.4.0-Gx6Dlj0rchWGrfXCDHk4fo" False) (C1 (MetaCons "ProjectsInstancesDatabasesSessionsPartitionQuery'" PrefixI True) ((S1 (MetaSel (Just "_pidspqXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_pidspqUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_pidspqAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_pidspqUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_pidspqPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PartitionQueryRequest)) :: (S1 (MetaSel (Just "_pidspqSession") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_pidspqCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsInstancesDatabasesSessionsPartitionQuery Source #
Instance details Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.PartitionQuery type Scopes ProjectsInstancesDatabasesSessionsPartitionQuery = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/spanner.data" ': ([] :: [Symbol]))
type Rs ProjectsInstancesDatabasesSessionsPartitionQuery Source #
Instance details Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.PartitionQuery type Rs ProjectsInstancesDatabasesSessionsPartitionQuery = PartitionResponse

Request Lenses

pidspqXgafv :: Lens' ProjectsInstancesDatabasesSessionsPartitionQuery (Maybe Xgafv) Source #

V1 error format.

pidspqUploadProtocol :: Lens' ProjectsInstancesDatabasesSessionsPartitionQuery (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

pidspqAccessToken :: Lens' ProjectsInstancesDatabasesSessionsPartitionQuery (Maybe Text) Source #

OAuth access token.

pidspqUploadType :: Lens' ProjectsInstancesDatabasesSessionsPartitionQuery (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

pidspqPayload :: Lens' ProjectsInstancesDatabasesSessionsPartitionQuery PartitionQueryRequest Source #

Multipart request metadata.

pidspqSession :: Lens' ProjectsInstancesDatabasesSessionsPartitionQuery Text Source #

Required. The session used to create the partitions.

pidspqCallback :: Lens' ProjectsInstancesDatabasesSessionsPartitionQuery (Maybe Text) Source #

JSONP