Log.SqlQuery

A module for creating great logs in code that makes SQL queries.

Documentation

data Details

A type describing an SQL query.

emptyDetails
  { query = Just (Log.mkSecret "SELECT cuddles FROM puppies")
  , database = Just postgresql
  }

Instances

Generic Details

Defined in Log.SqlQuery

Associated Types

type Rep Details :: Type -> Type

Methods

from :: Details -> Rep Details x

to :: Rep Details x -> Details

ToJSON Details

Defined in Log.SqlQuery

Methods

toJSON :: Details -> Value

toEncoding :: Details -> Encoding

toJSONList :: [Details] -> Value

toEncodingList :: [Details] -> Encoding

TracingSpanDetails Details

Defined in Log.SqlQuery

Methods

toTracingSpanDetails :: Details -> SomeTracingSpanDetails

fromTracingSpanDetails :: SomeTracingSpanDetails -> Maybe Details

type Rep Details

Defined in Log.SqlQuery

type Rep Details = D1 ('MetaData "Details" "Log.SqlQuery" "nri-observability-0.1.1.1-6drCxSGgDW1KoXdqKTw2T1" 'False) (C1 ('MetaCons "Details" 'PrefixI 'True) (((S1 ('MetaSel ('Just "query") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Secret Text))) :*: S1 ('MetaSel ('Just "queryTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "sqlOperation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "queriedRelation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "databaseType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "database") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "rowsReturned") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))))

emptyDetails :: Details

An empty details value to be modified by you.

query :: Details -> Maybe (Secret Text)

The full query we're executing.

queryTemplate :: Details -> Maybe Text

The query we're executing with values mocked out.

sqlOperation :: Details -> Maybe Text

The SQL operation we're performing (SELECT INSERT DELETE / ...).

queriedRelation :: Details -> Maybe Text

The primary relation of the query.

databaseType :: Details -> Maybe Text

The type of database.

host :: Details -> Maybe Text

Database host the connection is made to.

port :: Details -> Maybe Int

Port the database is running on.

database :: Details -> Maybe Text

The name of the database that is being queried.

rowsReturned :: Details -> Maybe Int

The amount of rows this query returned.

mysql :: Text

MySQL

postgresql :: Text

Postgresql