Copyright	(c) Soostone Inc 2020
License	AllRightsReserved
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Napkin.Run.BigQuery

Contents

Utilities
Orphan instances

Description

Synopsis

data BigQueryRunError
- = ProtoErrors !(NonEmpty ErrorProto)
- | MissingDatasetId
- | MissingProjectId
mkBigQueryEnv :: (MonadCatch m, Katip m) => Maybe FilePath -> BQProjectId -> Maybe BQDatasetId -> HashMap Text Text -> m (BackendConn BigQuery)
mkBigQueryEnv' :: (MonadCatch m, MonadIO m) => IO GoogleEnv -> BQProjectId -> Maybe BQDatasetId -> HashMap Text Text -> m (BackendConn BigQuery)
mkBigQueryEnvWithCredentials :: (MonadCatch m, Katip m) => Maybe ByteString -> Credentials BigQueryScopes -> BQProjectId -> Maybe BQDatasetId -> HashMap Text Text -> m (BackendConn BigQuery)
mkBigQueryEnvWithJsonCredentials :: (MonadCatch m, Katip m) => Maybe ByteString -> CredentialsJson -> BQProjectId -> Maybe BQDatasetId -> HashMap Text Text -> m (BackendConn BigQuery)
mkBigQueryEnvWithCredentialsFile :: (MonadCatch m, Katip m) => FilePath -> BQProjectId -> Maybe BQDatasetId -> HashMap Text Text -> m (BackendConn BigQuery)
data family BackendConn b
decomposeRef :: Ref Table -> (Maybe BQProjectId, Maybe BQDatasetId, BQTableId)
data AuthInput = AuthInput {
- _authInput_specFile :: SpecFile
- _authInput_credentialsDb :: Maybe FilePath
- _authInput_authPort :: Maybe Int
- _authInput_connStr :: String
- _authInput_appName :: Maybe AppName
}
asOAuth2Context :: forall m. (MonadIO m, MonadCatch m) => AuthInput -> m OAuth2Context

Documentation

data BigQueryRunError #

Constructors

ProtoErrors !(NonEmpty ErrorProto)
MissingDatasetId
MissingProjectId

Instances

Instances details

Eq BigQueryRunError #
Instance details Defined in Napkin.Run.BigQuery Methods (==) :: BigQueryRunError -> BigQueryRunError -> Bool # (/=) :: BigQueryRunError -> BigQueryRunError -> Bool #
Show BigQueryRunError #
Instance details Defined in Napkin.Run.BigQuery Methods showsPrec :: Int -> BigQueryRunError -> ShowS # show :: BigQueryRunError -> String # showList :: [BigQueryRunError] -> ShowS #
Exception BigQueryRunError #
Instance details Defined in Napkin.Run.BigQuery Methods toException :: BigQueryRunError -> SomeException # fromException :: SomeException -> Maybe BigQueryRunError # displayException :: BigQueryRunError -> String #

mkBigQueryEnv #

Arguments

:: (MonadCatch m, Katip m)
=> Maybe FilePath	location of credentials file.
-> BQProjectId	Default project
-> Maybe BQDatasetId	Default dataset
-> HashMap Text Text
-> m (BackendConn BigQuery)

create a google BigQuery environment. we take the maybe provided credential file. If none, then try to use the gCloud SDK credentials

mkBigQueryEnv' #

Arguments

:: (MonadCatch m, MonadIO m)
=> IO GoogleEnv	How do we set up each entry in the GoogleEnv pool?
-> BQProjectId	Default project
-> Maybe BQDatasetId	Default dataset
-> HashMap Text Text
-> m (BackendConn BigQuery)

Make a BigQuery env but with control over configuring how the Google environment is set up. You should usually call mkGoogleEnv and then fmap some customization over it.

mkBigQueryEnvWithCredentials #

Arguments

:: (MonadCatch m, Katip m)
=> Maybe ByteString
-> Credentials BigQueryScopes
-> BQProjectId	Default project
-> Maybe BQDatasetId	Default dataset
-> HashMap Text Text
-> m (BackendConn BigQuery)

create a google BigQuery environment.

mkBigQueryEnvWithJsonCredentials #

Arguments

:: (MonadCatch m, Katip m)
=> Maybe ByteString
-> CredentialsJson
-> BQProjectId	Default project
-> Maybe BQDatasetId	Default dataset
-> HashMap Text Text
-> m (BackendConn BigQuery)

mkBigQueryEnvWithCredentialsFile #

Arguments

:: (MonadCatch m, Katip m)
=> FilePath	location of credentials file.
-> BQProjectId	Default project
-> Maybe BQDatasetId	Default dataset
-> HashMap Text Text
-> m (BackendConn BigQuery)

create a google BigQuery environment.

data family BackendConn b #

Instances

Instances details

data BackendConn Sqlite #
Instance details Defined in Napkin.Run.Sqlite data BackendConn Sqlite = SqliteConn (Pool Connection)
data BackendConn Redshift #
Instance details Defined in Napkin.Run.Redshift data BackendConn Redshift = RedshiftConn (Pool Connection)
data BackendConn Postgres #
Instance details Defined in Napkin.Run.Postgres data BackendConn Postgres = PostgresConn { getPostgresConn :: Pool Connection }
data BackendConn BigQuery #
Instance details Defined in Napkin.Run.BigQuery data BackendConn BigQuery = BigQueryEnv { bqeEnv :: Pool GoogleEnv bqeDefProjectId :: Tagged "default" BQProjectId bqeDefDatasetId :: Maybe (Tagged "default" BQDatasetId) bqeJobLabels :: HashMap Text Text }

Utilities

decomposeRef :: Ref Table -> (Maybe BQProjectId, Maybe BQDatasetId, BQTableId) #

segs are [project[dataset]]table. Usually combines with default dataset id and project id to fully resolve Refs.

data AuthInput #

Constructors

AuthInput
Fields _authInput_specFile :: SpecFile Spec flie path _authInput_credentialsDb :: Maybe FilePath credential db override _authInput_authPort :: Maybe Int auth port override _authInput_connStr :: String connection string _authInput_appName :: Maybe AppName app name

asOAuth2Context :: forall m. (MonadIO m, MonadCatch m) => AuthInput -> m OAuth2Context #

Orphan instances

Backend BigQuery #
Instance details Associated Types data BackendConn BigQuery # Methods backendQuery :: (Katip m, MonadQueryStats m, RenderSql q BigQuery) => BackendConn BigQuery -> q -> m [Map Text Value] # backendExecute :: (Katip m, MonadQueryStats m, RenderSql q BigQuery) => BackendConn BigQuery -> q -> m () #
RunBackendConn BigQuery #
Instance details Methods runBackendConn :: LogEnv -> DbBackendOptions BigQuery -> ConnectionString -> Maybe AppName -> Maybe CredentialsPath -> SpecFile -> Maybe AuthPort -> (BackendConn BigQuery -> IO a) -> IO a #
Command Grant () BigQuery #
Instance details Methods execCommand :: (Katip m, MonadQueryStats m) => BackendConn BigQuery -> Grant -> m () #
Command CheckTableExists Bool BigQuery #
Instance details Methods execCommand :: (Katip m, MonadQueryStats m) => BackendConn BigQuery -> CheckTableExists -> m Bool #
Command DeleteFrom Job BigQuery #
Instance details Methods execCommand :: (Katip m, MonadQueryStats m) => BackendConn BigQuery -> DeleteFrom -> m Job #
Command InsertIntoQuery Job BigQuery #
Instance details Methods execCommand :: (Katip m, MonadQueryStats m) => BackendConn BigQuery -> InsertIntoQuery -> m Job #
Command DropTable () BigQuery #
Instance details Methods execCommand :: (Katip m, MonadQueryStats m) => BackendConn BigQuery -> DropTable -> m () #
Command DropView () BigQuery #
Instance details Methods execCommand :: (Katip m, MonadQueryStats m) => BackendConn BigQuery -> DropView -> m () #
Command CreateViewAs Table BigQuery #
Instance details Methods execCommand :: (Katip m, MonadQueryStats m) => BackendConn BigQuery -> CreateViewAs -> m Table #
Command CopyTable () BigQuery #
Instance details Methods execCommand :: (Katip m, MonadQueryStats m) => BackendConn BigQuery -> CopyTable -> m () #
Command RenameTable () BigQuery #	BQ implements rename via copy-then-drop
Instance details Methods execCommand :: (Katip m, MonadQueryStats m) => BackendConn BigQuery -> RenameTable -> m () #
Command GetRelationSchema (Fields Field) BigQuery #
Instance details Methods execCommand :: (Katip m, MonadQueryStats m) => BackendConn BigQuery -> GetRelationSchema -> m (Fields Field) #
Command (CreateTableAs ()) Job BigQuery #
Instance details Methods execCommand :: (Katip m, MonadQueryStats m) => BackendConn BigQuery -> CreateTableAs () -> m Job #
Command (CreateTableAs TableMeta) Job BigQuery #
Instance details Methods execCommand :: (Katip m, MonadQueryStats m) => BackendConn BigQuery -> CreateTableAs TableMeta -> m Job #