Safe Haskell	None
Language	Haskell2010

Hmssql.Tds.Context

Description

Runtime state that affects how TDS messages are serialized and parsed.

Every get/put function in "Hmssql.Tds.*" takes a TdsContext so that protocol-version-dependent encodings are decided in one place.

Synopsis

Documentation

Protocol versions this library can negotiate.

TDS 7.4 is the baseline (SQL Server 2017 and later, Azure SQL). TDS 8.0 is the same token stream over TLS from byte zero ("strict" encryption).

Constructors

Tds74
Tds80

Instances details

Bounded TdsVersion Source #
Instance details Defined in Hmssql.Tds.Context Methods minBound :: TdsVersion # maxBound :: TdsVersion #
Enum TdsVersion Source #
Instance details Defined in Hmssql.Tds.Context Methods succ :: TdsVersion -> TdsVersion # pred :: TdsVersion -> TdsVersion # toEnum :: Int -> TdsVersion # fromEnum :: TdsVersion -> Int # enumFrom :: TdsVersion -> [TdsVersion] # enumFromThen :: TdsVersion -> TdsVersion -> [TdsVersion] # enumFromTo :: TdsVersion -> TdsVersion -> [TdsVersion] # enumFromThenTo :: TdsVersion -> TdsVersion -> TdsVersion -> [TdsVersion] #
Show TdsVersion Source #
Instance details Defined in Hmssql.Tds.Context Methods showsPrec :: Int -> TdsVersion -> ShowS # show :: TdsVersion -> String # showList :: [TdsVersion] -> ShowS #
Eq TdsVersion Source #
Instance details Defined in Hmssql.Tds.Context Methods (==) :: TdsVersion -> TdsVersion -> Bool # (/=) :: TdsVersion -> TdsVersion -> Bool #
Ord TdsVersion Source #
Instance details Defined in Hmssql.Tds.Context Methods compare :: TdsVersion -> TdsVersion -> Ordering # (<) :: TdsVersion -> TdsVersion -> Bool # (<=) :: TdsVersion -> TdsVersion -> Bool # (>) :: TdsVersion -> TdsVersion -> Bool # (>=) :: TdsVersion -> TdsVersion -> Bool # max :: TdsVersion -> TdsVersion -> TdsVersion # min :: TdsVersion -> TdsVersion -> TdsVersion #

The version DWORD sent in LOGIN7 (little-endian on the wire).

Interpret the version DWORD from LOGINACK (big-endian on the wire).

The server's identifier for the session's transaction, from a transaction ENVCHANGE, which every request sends back in its ALL_HEADERS.

Constructors

Instances details

Show TransactionDescriptor Source #
Instance details Defined in Hmssql.Tds.Context Methods showsPrec :: Int -> TransactionDescriptor -> ShowS # show :: TransactionDescriptor -> String # showList :: [TransactionDescriptor] -> ShowS #
Eq TransactionDescriptor Source #
Instance details Defined in Hmssql.Tds.Context Methods (==) :: TransactionDescriptor -> TransactionDescriptor -> Bool # (/=) :: TransactionDescriptor -> TransactionDescriptor -> Bool #
Ord TransactionDescriptor Source #
Instance details Defined in Hmssql.Tds.Context Methods compare :: TransactionDescriptor -> TransactionDescriptor -> Ordering # (<) :: TransactionDescriptor -> TransactionDescriptor -> Bool # (<=) :: TransactionDescriptor -> TransactionDescriptor -> Bool # (>) :: TransactionDescriptor -> TransactionDescriptor -> Bool # (>=) :: TransactionDescriptor -> TransactionDescriptor -> Bool # max :: TransactionDescriptor -> TransactionDescriptor -> TransactionDescriptor # min :: TransactionDescriptor -> TransactionDescriptor -> TransactionDescriptor #

The protocol state a connection has negotiated, which the encoders and parsers take as an argument; connectionContext reads a connection's.

Constructors

Fields

tdsVersion :: !TdsVersion
The version the server agreed to in LOGINACK.
tdsPacketSize :: !Word32
Negotiated packet size, including the 8-byte header.
tdsTransaction :: !(Maybe TransactionDescriptor)
Current transaction, sent in the ALL_HEADERS of every request.
tdsUtf8Support :: !Bool
Server acknowledged the UTF8_SUPPORT feature extension.
tdsCollation :: !(Maybe ByteString)
The session's default collation, the five bytes of the last SQL collation ENVCHANGE (at login, and after a USE), if any: what a string is sent with where a collation is needed and none is known (a sql_variant value in Hmssql.BulkCopy).

Instances details

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

TDS 7.4, 4096-byte packets, no transaction: what a connection starts from, and what the pure encoders are tested with.

The range of packet sizes, header included, that SQL Server negotiates (its network packet size option; MS-TDS 2.2.6.4 LOGIN7 PacketSize).

The range of packet sizes, header included, that SQL Server negotiates (its network packet size option; MS-TDS 2.2.6.4 LOGIN7 PacketSize).

The nearest packet size in minPacketSize .. maxPacketSize.