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

Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method cannot be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a `FAILED_PRECONDITION` error. Reads inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be yielded in streaming fashion by calling StreamingRead instead.

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

REST Resource

type ProjectsInstancesDatabasesSessionsReadResource = "v1" :> (CaptureMode "session" "read" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] ReadRequest :> Post '[JSON] ResultSet))))))))

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

Creating a Request

projectsInstancesDatabasesSessionsRead

Arguments

:: ReadRequest

pidsrPayload

-> Text

pidsrSession

-> ProjectsInstancesDatabasesSessionsRead

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

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

• pidsrXgafv
• pidsrUploadProtocol
• pidsrAccessToken
• pidsrUploadType
• pidsrPayload
• pidsrSession
• pidsrCallback

data ProjectsInstancesDatabasesSessionsRead

Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method cannot be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a `FAILED_PRECONDITION` error. Reads inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be yielded in streaming fashion by calling StreamingRead instead.

See: projectsInstancesDatabasesSessionsRead smart constructor.

Instances

Eq ProjectsInstancesDatabasesSessionsRead

Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.Read

Methods

(==) :: ProjectsInstancesDatabasesSessionsRead -> ProjectsInstancesDatabasesSessionsRead -> Bool

(/=) :: ProjectsInstancesDatabasesSessionsRead -> ProjectsInstancesDatabasesSessionsRead -> Bool

Data ProjectsInstancesDatabasesSessionsRead

Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.Read

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsInstancesDatabasesSessionsRead -> c ProjectsInstancesDatabasesSessionsRead

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsInstancesDatabasesSessionsRead

toConstr :: ProjectsInstancesDatabasesSessionsRead -> Constr

dataTypeOf :: ProjectsInstancesDatabasesSessionsRead -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsInstancesDatabasesSessionsRead)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsInstancesDatabasesSessionsRead)

gmapT :: (forall b. Data b => b -> b) -> ProjectsInstancesDatabasesSessionsRead -> ProjectsInstancesDatabasesSessionsRead

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsInstancesDatabasesSessionsRead -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsInstancesDatabasesSessionsRead -> r

gmapQ :: (forall d. Data d => d -> u) -> ProjectsInstancesDatabasesSessionsRead -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsInstancesDatabasesSessionsRead -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsInstancesDatabasesSessionsRead -> m ProjectsInstancesDatabasesSessionsRead

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsInstancesDatabasesSessionsRead -> m ProjectsInstancesDatabasesSessionsRead

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsInstancesDatabasesSessionsRead -> m ProjectsInstancesDatabasesSessionsRead

Show ProjectsInstancesDatabasesSessionsRead

Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.Read

Methods

showsPrec :: Int -> ProjectsInstancesDatabasesSessionsRead -> ShowS

show :: ProjectsInstancesDatabasesSessionsRead -> String

showList :: [ProjectsInstancesDatabasesSessionsRead] -> ShowS

Generic ProjectsInstancesDatabasesSessionsRead

Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.Read

Associated Types

type Rep ProjectsInstancesDatabasesSessionsRead :: Type -> Type

Methods

from :: ProjectsInstancesDatabasesSessionsRead -> Rep ProjectsInstancesDatabasesSessionsRead x

to :: Rep ProjectsInstancesDatabasesSessionsRead x -> ProjectsInstancesDatabasesSessionsRead

GoogleRequest ProjectsInstancesDatabasesSessionsRead

Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.Read

Associated Types

type Rs ProjectsInstancesDatabasesSessionsRead :: Type

type Scopes ProjectsInstancesDatabasesSessionsRead :: [Symbol]

Methods

requestClient :: ProjectsInstancesDatabasesSessionsRead -> GClient (Rs ProjectsInstancesDatabasesSessionsRead)

type Rep ProjectsInstancesDatabasesSessionsRead

Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.Read

type Rep ProjectsInstancesDatabasesSessionsRead = D1 (MetaData "ProjectsInstancesDatabasesSessionsRead" "Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.Read" "gogol-spanner-0.4.0-Gx6Dlj0rchWGrfXCDHk4fo" False) (C1 (MetaCons "ProjectsInstancesDatabasesSessionsRead'" PrefixI True) ((S1 (MetaSel (Just "_pidsrXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_pidsrUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pidsrAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_pidsrUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pidsrPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ReadRequest)) :*: (S1 (MetaSel (Just "_pidsrSession") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_pidsrCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Scopes ProjectsInstancesDatabasesSessionsRead

Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.Read

type Scopes ProjectsInstancesDatabasesSessionsRead = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/spanner.data" ': ([] :: [Symbol]))

type Rs ProjectsInstancesDatabasesSessionsRead

Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.Read

type Rs ProjectsInstancesDatabasesSessionsRead = ResultSet

Request Lenses

pidsrXgafv :: Lens' ProjectsInstancesDatabasesSessionsRead (Maybe Xgafv)

V1 error format.

pidsrUploadProtocol :: Lens' ProjectsInstancesDatabasesSessionsRead (Maybe Text)

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

pidsrAccessToken :: Lens' ProjectsInstancesDatabasesSessionsRead (Maybe Text)

OAuth access token.

pidsrUploadType :: Lens' ProjectsInstancesDatabasesSessionsRead (Maybe Text)

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

pidsrPayload :: Lens' ProjectsInstancesDatabasesSessionsRead ReadRequest

Multipart request metadata.

pidsrSession :: Lens' ProjectsInstancesDatabasesSessionsRead Text

Required. The session in which the read should be performed.

pidsrCallback :: Lens' ProjectsInstancesDatabasesSessionsRead (Maybe Text)

JSONP