Safe Haskell	None
Language	Haskell2010

Hmssql.Tds.Token

Description

Server tokens expressed as sequential reading recipes.

Synopsis

data Token
- = TColMetaData ![ColumnInfo]
- | TRow !Row
- | TDone !Done
- | TDoneProc !Done
- | TDoneInProc !Done
- | TEnvChange !EnvChange
- | TError !ServerMessage
- | TInfo !ServerMessage
- | TLoginAck !LoginAck
- | TReturnStatus !Int32
- | TReturnValue !ReturnValue
- | TOrder ![Word16]
- | TColInfo !ByteString
- | TTabName !ByteString
- | TFeatureExtAck ![FeatureAck]
- | TSessionState !ByteString
- | TFedAuthInfo !ByteString
- | TSspi !ByteString
- | TOffset !Word16 !Word16
data ColumnInfo = ColumnInfo {
- columnName :: !Text
- columnType :: !TypeInfo
- columnFlags :: !Word16
- columnUserType :: !Word32
- columnTableName :: !(Maybe [Text])
}
columnIsNullable :: ColumnInfo -> Bool
columnIsLong :: ColumnInfo -> Bool
data ResultSetInfo
rsColumns :: ResultSetInfo -> [ColumnInfo]
rsColumnArray :: ResultSetInfo -> SmallArray ColumnInfo
rsColumnCount :: ResultSetInfo -> Int
rsCells :: ResultSetInfo -> [(Int, ColumnShape)]
compileResultSet :: [ColumnInfo] -> ResultSetInfo
tokenSizeLimit :: Int
lobAllocAhead :: Int
data Done = Done {
- doneStatus :: !Word16
- doneCurCmd :: !Word16
- doneRowCount :: !Word64
}
doneMore :: Done -> Bool
doneError :: Done -> Bool
doneInTransaction :: Done -> Bool
doneHasCount :: Done -> Bool
doneAttention :: Done -> Bool
doneServerError :: Done -> Bool
data EnvChange
- = ECDatabase {
  - oldValue :: !Text
  - newValue :: !Text
  }
- | ECLanguage {
  - oldValue :: !Text
  - newValue :: !Text
  }
- | ECCharacterSet {
  - oldValue :: !Text
  - newValue :: !Text
  }
- | ECPacketSize {
  - oldSize :: !Word32
  - newSize :: !Word32
  }
- | ECUnicodeSortingLocale {
  - newValue :: !Text
  }
- | ECUnicodeComparisonFlags {
  - newValue :: !Text
  }
- | ECSqlCollation {
  - oldBytes :: !ByteString
  - newBytes :: !ByteString
  }
- | ECBeginTransaction {
  - transaction :: !TransactionDescriptor
  }
- | ECCommitTransaction {
  - transaction :: !TransactionDescriptor
  }
- | ECRollbackTransaction {
  - transaction :: !TransactionDescriptor
  }
- | ECEnlistDtcTransaction {
  - transaction :: !TransactionDescriptor
  }
- | ECDefectTransaction {
  - transaction :: !TransactionDescriptor
  }
- | ECMirroringPartner {
  - newValue :: !Text
  }
- | ECPromoteTransaction {
  - dtcToken :: !ByteString
  }
- | ECTransactionManagerAddress {
  - newBytes :: !ByteString
  }
- | ECTransactionEnded {
  - transaction :: !TransactionDescriptor
  }
- | ECResetConnectionAck
- | ECUserInstance {
  - newValue :: !Text
  }
- | ECRouting {
  - routing :: !RoutingInfo
  }
- | ECUnknown {
  - envChangeType :: !Word8
  - payload :: !ByteString
  }
data RoutingInfo = RoutingInfo {
- routingProtocol :: !Word8
- routingPort :: !Word16
- routingServer :: !Text
}
data ServerMessage = ServerMessage {
- msgNumber :: !Int32
- msgState :: !Word8
- msgClass :: !Word8
- msgText :: !Text
- msgServer :: !Text
- msgProcedure :: !Text
- msgLine :: !Int32
}
data LoginAck = LoginAck {
- laInterface :: !Word8
- laTdsVersion :: !Word32
- laProgName :: !Text
- laProgVersion :: !(Word8, Word8, Word8, Word8)
}
data ReturnValue = ReturnValue {
- rvOrdinal :: !Word16
- rvName :: !Text
- rvStatus :: !Word8
- rvUserType :: !Word32
- rvFlags :: !Word16
- rvType :: !TypeInfo
- rvValue :: !RawBytes
}
data FeatureAck = FeatureAck {
- featureId :: !Word8
- featureData :: !ByteString
}
readToken :: Maybe ResultSetInfo -> Parser Token
readTokenWith :: Int -> Maybe ResultSetInfo -> Parser Token
readTokenSkipping :: Maybe ResultSetInfo -> Parser Token
doneOf :: Token -> Maybe Done
isFinalDone :: Token -> Bool
failedDoneOf :: Token -> Maybe Done

Documentation

data Token Source #

A token of a response, as readToken reads it.

Constructors

TColMetaData ![ColumnInfo]	0x81; empty when the server reports no columns
TRow !Row	0xD1 ROW or 0xD2 NBCROW; see Hmssql.Tds.Value
TDone !Done	0xFD
TDoneProc !Done	0xFE
TDoneInProc !Done	0xFF
TEnvChange !EnvChange	0xE3
TError !ServerMessage	0xAA
TInfo !ServerMessage	0xAB
TLoginAck !LoginAck	0xAD
TReturnStatus !Int32	0x79
TReturnValue !ReturnValue	0xAC
TOrder ![Word16]	0xA9
TColInfo !ByteString	0xA5, undecoded
TTabName !ByteString	0xA4, undecoded
TFeatureExtAck ![FeatureAck]	0xAE
TSessionState !ByteString	0xE4, undecoded
TFedAuthInfo !ByteString	0xEE, undecoded
TSspi !ByteString	0xED
TOffset !Word16 !Word16	0x78

Instances

Instances details

Show Token Source #
Instance details Defined in Hmssql.Tds.Token Methods showsPrec :: Int -> Token -> ShowS # show :: Token -> String # showList :: [Token] -> ShowS #
Eq Token Source #
Instance details Defined in Hmssql.Tds.Token Methods (==) :: Token -> Token -> Bool # (/=) :: Token -> Token -> Bool #

data ColumnInfo Source #

A column of a result set, as its COLMETADATA describes it.

Constructors

ColumnInfo

Fields

columnName :: !Text
The name, or empty for an unnamed expression.
columnType :: !TypeInfo
The wire type; columnSqlType names the SQL type.
columnFlags :: !Word16
MS-TDS 2.2.7.4 Flags: nullable (columnIsNullable), identity, updatable and the rest.
columnUserType :: !Word32
The UserType field: 0x50 for rowversion, greater than 0xFF for alias types, and 0 for other types. An alias ID does not carry its name; columnType describes its underlying storage type.
columnTableName :: !(Maybe [Text])
Only present for text, ntext and image columns.

Instances

Instances details

Show ColumnInfo Source #
Instance details Defined in Hmssql.Tds.Token Methods showsPrec :: Int -> ColumnInfo -> ShowS # show :: ColumnInfo -> String # showList :: [ColumnInfo] -> ShowS #
Eq ColumnInfo Source #
Instance details Defined in Hmssql.Tds.Token Methods (==) :: ColumnInfo -> ColumnInfo -> Bool # (/=) :: ColumnInfo -> ColumnInfo -> Bool #

columnIsNullable :: ColumnInfo -> Bool Source #

Whether the column may hold NULL.

columnIsLong :: ColumnInfo -> Bool Source #

Whether a column's values may be of any length: a max type, xml, json, a CLR type, or a legacy text, ntext or image, which arrive in pieces rather than behind a length of at most 8,000 bytes. Such a column is the one to read with a FoldingCell or streamField.

data ResultSetInfo Source #

A result set's columns, prepared once for the rows that follow.

rsColumns :: ResultSetInfo -> [ColumnInfo] Source #

The columns, in order.

rsColumnArray :: ResultSetInfo -> SmallArray ColumnInfo Source #

The same, for indexing.

rsColumnCount :: ResultSetInfo -> Int Source #

How many columns the result set has.

rsCells :: ResultSetInfo -> [(Int, ColumnShape)] Source #

Each column's index, and how its values are delimited.

compileResultSet :: [ColumnInfo] -> ResultSetInfo Source #

Prepare a result set's columns for its rows.

tokenSizeLimit :: Int Source #

Maximum size of metadata tokens, which must not buffer unbounded input. Rows and output parameter values aren't bound by it: they cost their size.

lobAllocAhead :: Int Source #

Default maximum allocation ahead of received value bytes. A server that declares a value it doesn't send costs this much, not what it declared.

data Done Source #

A DONE, DONEPROC or DONEINPROC token: its status bits, which doneMore and the functions beside it read, the current command, and the row count.

Constructors

Done
Fields doneStatus :: !Word16 doneCurCmd :: !Word16 doneRowCount :: !Word64 Only meaningful when `doneHasCount`.