Safe Haskell	None
Language	Haskell2010

Database.TDS.Proto

Contents

Misc data types
Packets
- Packet header
Packet payloads
- PRELOGIN Payload
- LOGIN7 Payload
Packet decoders
- PRELOGIN response
Tokens
Tabular results
Splitting packets
KnownBool type class

Synopsis

cancelPacketSize :: CSize
maximumPayloadPacketSize :: CSize
pktHdrSz :: CSize
data Sender
- = Client
- | Server
data ResponseInfo a
- = ExpectsResponse (ResponseType a)
- | NoResponse
data ResponseType a = ResponseType Bool a
data StreamType
- = TokenlessStream
- | TokenStream
data Unimplemented
newtype SPID = SPID Word16
data PacketType (sender :: Sender) (resp :: ResponseInfo *) (d :: *) where
- PreLogin :: PacketType Client (ExpectsResponse (ResponseType False PreLogin)) PreLogin
- Login7 :: PacketType Client (ExpectsResponse (ResponseType False Login7Ack)) Login7
- SQLBatch :: PacketType Client (ExpectsResponse (ResponseType True RowResults)) Text
- BulkLoad :: PacketType Client NoResponse Unimplemented
- RPC :: PacketType Client NoResponse Unimplemented
- Attention :: PacketType Client (ExpectsResponse (ResponseType False ())) ()
- TrMgrRequest :: PacketType Client NoResponse Unimplemented
- TabularResult :: PacketType Server NoResponse a
packetType :: PacketType sender resp d -> Word8
newtype PacketStatus (s :: Sender) = PacketStatus Word8
hasStatus :: PacketStatus s -> PacketStatus s -> Bool
pktStatusEndOfMessage :: PacketStatus s
pktStatusIgnore :: PacketStatus Client
pktStatusResetConn :: PacketStatus Client
pktStatusResetConnSkipTran :: PacketStatus Client
newtype PacketSequenceID = PacketSequenceID Word8
type family Packed (packed :: Bool) (a :: *) (b :: *) where ...
data PacketHeader (sender :: Sender) (resp :: ResponseInfo *) (d :: *) where
- PacketHeader :: {..} -> PacketHeader sender resp d
mkPacketHeader :: PacketType sender resp d -> PacketStatus sender -> PacketHeader sender resp d
writeHdr :: Ptr a -> PacketHeader Client resp d -> IO ()
readHdr :: PacketType sender resp d -> Ptr a -> IO (Maybe (PacketHeader sender resp d))
data Packet (sender :: Sender) (resp :: ResponseInfo *) (d :: *) (f :: * -> *) where
- Packet :: {..} -> Packet sender resp d f
mkPacket :: PacketHeader sender resp d -> d -> Packet sender resp d Identity
packetEncoding :: Payload d => Packet sender resp d Identity -> Packet sender resp d PacketEncoding
displayRequest :: Show d => Packet sender resp d Identity -> String
data PayloadEncoder (streaming :: StreamType) where
- PayloadStreamEncoder :: Builder -> PayloadEncoder TokenStream
- PayloadBatchEncoder :: Word -> Builder -> PayloadEncoder TokenlessStream
newtype PacketEncoding pld = PacketEncoding (PayloadEncoder (PayloadStreaming pld))
class Show pld => Payload pld where
- type PayloadStreaming pld :: StreamType
- encodePayload :: pld -> PayloadEncoder (PayloadStreaming pld)
runBatchEncoder :: Monoid fixup => Tardis fixup (Builder, Word) () -> PayloadEncoder TokenlessStream
getFixups :: Tardis fixup (Builder, Word) fixup
getPosition :: Tardis fixup (Builder, Word) Word
fixup :: Monoid fixup => fixup -> Tardis fixup (Builder, Word) ()
emit :: Word -> Builder -> Tardis fixup (Builder, Word) ()
newtype MajorVersion = MajorVersion Word8
newtype MinorVersion = MinorVersion Word8
newtype BuildNumber = BuildNumber Word16
newtype SubBuildNumber = SubBuildNumber Word16
data Encryption
- = EncryptionOff
- | EncryptionOn
- | EncryptionNotSupported
- | EncryptionRequired
data Nonce = Nonce !Word64 !Word64 !Word64 !Word64
data PreLoginOption
- = VersionOption !MajorVersion !MinorVersion !BuildNumber !SubBuildNumber
- | EncryptionOption !Encryption
- | InstanceNameOption !Text
- | ThreadIdOption !Word32
- | MarsOption !Bool
- | FedAuthRequiredOption !Word8
- | NonceOption !Nonce
type PreLoginOptions = [PreLoginOption]
versionOption :: MajorVersion -> MinorVersion -> BuildNumber -> SubBuildNumber -> PreLoginOptions
encryptionOff :: PreLoginOptions
newtype PreLogin = PreLoginP {
- preLoginOptions :: PreLoginOptions
}
newtype TDSVersion = TDSVersion {
- fromTDSVersion :: Word32
}
newtype ClientProgVersion = ClientProgVersion {
- fromClientProgVersion :: Word32
}
newtype ClientPID = ClientPID {
- fromClientPID :: Word32
}
newtype ConnectionID = ConnectionID {
- fromConnectionID :: Word32
}
newtype Login7Options = Login7Options {
- fromLogin7Options :: Word32
}
defaultLoginOptions :: Login7Options
data Login7Feature = Login7Feature
newtype LCID = LCID Word16
newtype CollationFlags = CollationFlags Word8
newtype CollationVersion = CollationVersion Word8
data Collation = Collation {
- collationLCID :: !LCID
- collationFlags :: !CollationFlags
- collationVersion :: !CollationVersion
}
data ClientID = ClientID !Word16 !Word32
tdsVersion71 :: TDSVersion
data Login7 = Login7P {
- login7_tdsVersion :: !TDSVersion
- login7_packetSize :: !Word32
- login7_clientProgVer :: !ClientProgVersion
- login7_clientPID :: !ClientPID
- login7_connectionID :: !ConnectionID
- login7_flags :: !Login7Options
- login7_clientTmZone :: !Word32
- login7_collation :: !Collation
- login7_hostName :: !Text
- login7_userName :: !Text
- login7_password :: !Text
- login7_appName :: !Text
- login7_serverName :: !Text
- login7_extension :: !Text
- login7_cltIntName :: !Text
- login7_language :: !Text
- login7_database :: !Text
- login7_clientID :: !ClientID
- login7_SSPI :: !Text
- login7_atchDbFile :: !Text
- login7_changePasswd :: !Text
- login7_SSPILong :: !Word32
- login7_extraFeatures :: [Login7Feature]
}
data Login7Fixups = Login7Fixups {
- login7_totalLen :: !(Sum Word32)
- login7_hostNameOfs :: !Word16
- login7_userNameOfs :: !Word16
- login7_passwordOfs :: !Word16
- login7_appNameOfs :: !Word16
- login7_serverNameOfs :: !Word16
- login7_extensionOfs :: !Word16
- login7_cltIntNameOfs :: !Word16
- login7_languageOfs :: !Word16
- login7_databaseOfs :: !Word16
- login7_SSPIOfs :: !Word16
- login7_atchDbFileOfs :: !Word16
- login7_changePasswdOfs :: !Word16
}
data ResponseDecoder (streaming :: StreamType) (res :: *) where
- DecodeBatchResponse :: (Ptr Word8 -> Word16 -> IO (Maybe res)) -> ResponseDecoder TokenlessStream res
- DecodeTokenStream :: (forall r. IO () -> Stream TokenStream IO r -> IO res) -> ResponseDecoder TokenStream res
class Show res => Response res where
- type ResponseStreaming res :: StreamType
- responseDecoder :: ResponseDecoder (ResponseStreaming res) res
type BatchDecoder = StateT (Ptr Word8, Word16) (ReaderT Word16 (MaybeT IO))
decodeBatch :: BatchDecoder a -> ResponseDecoder TokenlessStream a
read8 :: BatchDecoder Word8
read16BE :: BatchDecoder Word16
read32BE :: BatchDecoder Word32
read64BE :: BatchDecoder Word64
read16LE :: BatchDecoder Word16
read32LE :: BatchDecoder Word32
read64LE :: BatchDecoder Word64
ztText :: Word16 -> BatchDecoder Text
tell :: BatchDecoder Word16
seek :: Word16 -> BatchDecoder ()
data Login7Ack = Login7Ack !Word8 !TDSVersion !Text !ProgVersion
newtype DoneSts = DoneSts Word16
newtype ProgVersion = ProgVersion Word32
data Message = Message {
- messageCode :: !SQLError
- messageSt :: !Word8
- messageClass :: !ErrorClass
- messageText :: !Text
- messageServerName :: !Text
- messageProcName :: !Text
- messageLineNum :: Word16
}
data EnvChange
- = EnvChangeDatabase !Text !Text
- | EnvChangeLanguage !Text !Text
- | EnvChangeCollation !ByteString !ByteString
- | EnvChangeUnknown
data Token' f
- = TvpRow
- | Offset
- | ReturnStatus
- | ColMetadata !ColumnMetadata
- | AltMetadata
- | TableName
- | ColumnInfo
- | Order (Vector Word8)
- | Error !Message
- | Info !Message
- | ReturnValue
- | LoginAck !Word8 !TDSVersion !Text !ProgVersion
- | FeatureExtAck
- | Row !f
- | NbcRow
- | AltRow
- | EnvChange !EnvChange
- | SessionState
- | SSPI
- | FedAuthInfo
- | Done !DoneSts !Word16 !Word64
- | DoneProc
- | DoneInProc
type Token = Token' (ByteString IO ())
data TokenStream f
- = OneToken !Token f
- | ContParse !Token (ByteString IO () -> f)
doneHasMore :: DoneSts -> Bool
doneHasError :: DoneSts -> Bool
parseTokenStream :: ByteString IO () -> Stream TokenStream IO ()
usVarChar :: Parser (Int, Text)
bVarChar :: Parser (Int, Text)
bVarByte :: Parser (Int, ByteString)
parseToken :: Parser (Either (ByteString IO () -> Token) Token)
data EncryptionAlgorithm = EncryptionAlgorithm
data EncryptionAlgorithmType = EncryptionAlgorithmType
data CharKind
- = NormalChar
- | NationalChar
data PrecScale = PrecScale !Word8 !Word8
data TypeLen
- = ByteLen
- | ShortLen
data TypeInfo
- = NullType
- | IntNType !Bool !Word8
- | GuidType !Word8
- | DecimalType !Bool !Word8 !PrecScale
- | NumericType !Bool !Word8 !PrecScale
- | BitNType !Bool !Word8
- | DecimalNType !Bool !Word8 !PrecScale
- | NumericNType !Bool !Word8 !PrecScale
- | FloatNType !Bool !Word8
- | MoneyNType !Bool !Word8
- | DtTmNType !Bool !Word8
- | DateNType !Bool !Word8
- | TimeNType !Bool !Word8
- | DtTm2NType !Word8
- | DtTmOfsType !Word8
- | CharType !TypeLen !CharKind !Word16 !(Maybe Collation)
- | VarcharType !TypeLen !CharKind !Word16 !(Maybe Collation)
- | BinaryType !Word16
- | VarBinType !Word16
- | ImageType !Word32
- | NTextType !Word32 !Collation
- | SSVarType !Word32
- | TextType !Word32 !Collation
- | XMLType !Word32
data CryptoMetadata = CryptoMetadata {
- cryptoOrdinal :: !Word16
- cryptoUserType :: !Word32
- cryptoBaseType :: !TypeInfo
- cryptoEncAlgo :: !EncryptionAlgorithm
- cryptoAlgName :: !Text
- cryptoAlgType :: !EncryptionAlgorithmType
- cryptoNormVers :: !Word8
}
data ColumnData = ColumnData {
- cdUserType :: !Word32
- cdFlags :: !Word16
- cdBaseTypeInfo :: !TypeInfo
- cdTableName :: !(Maybe Text)
- cdCrypto :: !(Maybe CryptoMetadata)
- cdColName :: !Text
}
data ColumnMetadata = ColumnMetadata {
- cmCekTbl :: ByteString
- cmColData :: [ColumnData]
}
data RawColumn f where
- RawColumn :: ColumnData -> ByteString IO () -> (ByteString IO () -> f) -> RawColumn f
typeInfoParser :: Parser TypeInfo
colDataParser :: Parser ColumnData
colMetadataP :: Parser ColumnMetadata
newtype RowResults = RowResults {
- getRowResults :: Stream (Compose (Of ColumnMetadata) (Stream (Stream RawColumn IO) IO)) IO ()
}
data SplitEncoding sender resp pld
- = LastPacket (Ptr () -> IO CSize)
- | OnePacket (Ptr () -> IO (Packet sender resp pld (SplitEncoding sender resp)))
type SplitPacket sender resp pld = Packet sender resp pld (SplitEncoding sender resp)
splitPacket :: CSize -> Packet Client resp d PacketEncoding -> (Maybe CSize, SplitPacket Client resp d)
class KnownBool (b :: Bool) where
- boolVal :: p b -> Bool

Documentation

cancelPacketSize :: CSize Source #

maximumPayloadPacketSize :: CSize Source #

pktHdrSz :: CSize Source #

data Sender Source #

Constructors

Client
Server

Instances

Show Sender Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> Sender -> ShowS # show :: Sender -> String # showList :: [Sender] -> ShowS #

data ResponseInfo a Source #

Constructors

ExpectsResponse (ResponseType a)
NoResponse

Instances

Show a => Show (ResponseInfo a) Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> ResponseInfo a -> ShowS # show :: ResponseInfo a -> String # showList :: [ResponseInfo a] -> ShowS #

data ResponseType a Source #

Constructors

ResponseType
Fields Bool Cancelable a

Instances

Show a => Show (ResponseType a) Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> ResponseType a -> ShowS # show :: ResponseType a -> String # showList :: [ResponseType a] -> ShowS #

data StreamType Source #

Constructors

TokenlessStream
TokenStream

Instances

Show StreamType Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> StreamType -> ShowS # show :: StreamType -> String # showList :: [StreamType] -> ShowS #

data Unimplemented Source #

Instances

Show Unimplemented Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> Unimplemented -> ShowS # show :: Unimplemented -> String # showList :: [Unimplemented] -> ShowS #
Response Unimplemented Source #
Instance details Defined in Database.TDS.Proto Associated Types type ResponseStreaming Unimplemented :: StreamType Source # Methods responseDecoder :: ResponseDecoder (ResponseStreaming Unimplemented) Unimplemented Source #
type ResponseStreaming Unimplemented Source #
Instance details Defined in Database.TDS.Proto type ResponseStreaming Unimplemented = TokenlessStream

Misc data types

newtype SPID Source #

Constructors

SPID Word16

Instances

Eq SPID Source #
Instance details Defined in Database.TDS.Proto Methods (==) :: SPID -> SPID -> Bool # (/=) :: SPID -> SPID -> Bool #
Show SPID Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> SPID -> ShowS # show :: SPID -> String # showList :: [SPID] -> ShowS #

Packets

Packet header

data PacketType (sender :: Sender) (resp :: ResponseInfo *) (d :: *) where Source #

Data type representing valid packet types

Instances

Show (PacketType sender resp d) Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> PacketType sender resp d -> ShowS # show :: PacketType sender resp d -> String # showList :: [PacketType sender resp d] -> ShowS #

packetType :: PacketType sender resp d -> Word8 Source #

newtype PacketStatus (s :: Sender) Source #

Constructors

PacketStatus Word8

Instances

Show (PacketStatus s) Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> PacketStatus s -> ShowS # show :: PacketStatus s -> String # showList :: [PacketStatus s] -> ShowS #
Semigroup (PacketStatus s) Source #
Instance details Defined in Database.TDS.Proto Methods (<>) :: PacketStatus s -> PacketStatus s -> PacketStatus s # sconcat :: NonEmpty (PacketStatus s) -> PacketStatus s # stimes :: Integral b => b -> PacketStatus s -> PacketStatus s #
Monoid (PacketStatus s) Source #
Instance details Defined in Database.TDS.Proto Methods mempty :: PacketStatus s # mappend :: PacketStatus s -> PacketStatus s -> PacketStatus s # mconcat :: [PacketStatus s] -> PacketStatus s #

hasStatus :: PacketStatus s -> PacketStatus s -> Bool Source #

pktStatusEndOfMessage :: PacketStatus s Source #

pktStatusIgnore :: PacketStatus Client Source #

pktStatusResetConn :: PacketStatus Client Source #

pktStatusResetConnSkipTran :: PacketStatus Client Source #

newtype PacketSequenceID Source #

Constructors

PacketSequenceID Word8

Instances

Eq PacketSequenceID Source #
Instance details Defined in Database.TDS.Proto Methods (==) :: PacketSequenceID -> PacketSequenceID -> Bool # (/=) :: PacketSequenceID -> PacketSequenceID -> Bool #
Show PacketSequenceID Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> PacketSequenceID -> ShowS # show :: PacketSequenceID -> String # showList :: [PacketSequenceID] -> ShowS #

type family Packed (packed :: Bool) (a :: *) (b :: *) where ... Source #

Equations

Packed True a b = a
Packed False a b = b

data PacketHeader (sender :: Sender) (resp :: ResponseInfo *) (d :: *) where Source #

Constructors

PacketHeader
Fields :: { pktHdrType :: !(PacketType sender resp d) , pktHdrStatus :: !(PacketStatus sender) , pktHdrLength :: !Word16 , pktHdrSPID :: !SPID , pktHdrSeqID :: !PacketSequenceID , pktHdrWindow :: !Word8 } -> PacketHeader sender resp d

Instances

Show (PacketHeader sender resp d) Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> PacketHeader sender resp d -> ShowS # show :: PacketHeader sender resp d -> String # showList :: [PacketHeader sender resp d] -> ShowS #

mkPacketHeader :: PacketType sender resp d -> PacketStatus sender -> PacketHeader sender resp d Source #

writeHdr :: Ptr a -> PacketHeader Client resp d -> IO () Source #

readHdr :: PacketType sender resp d -> Ptr a -> IO (Maybe (PacketHeader sender resp d)) Source #

data Packet (sender :: Sender) (resp :: ResponseInfo *) (d :: *) (f :: * -> *) where Source #

Constructors

Packet
Fields :: { pktHdr :: !(PacketHeader sender resp d) , pktData :: !(f d) } -> Packet sender resp d f

Instances

Show d => Show (Packet sender resp d Identity) Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> Packet sender resp d Identity -> ShowS # show :: Packet sender resp d Identity -> String # showList :: [Packet sender resp d Identity] -> ShowS #

mkPacket :: PacketHeader sender resp d -> d -> Packet sender resp d Identity Source #

packetEncoding :: Payload d => Packet sender resp d Identity -> Packet sender resp d PacketEncoding Source #

displayRequest :: Show d => Packet sender resp d Identity -> String Source #

Packet payloads

data PayloadEncoder (streaming :: StreamType) where Source #

Constructors

PayloadStreamEncoder :: Builder -> PayloadEncoder TokenStream
PayloadBatchEncoder :: Word -> Builder -> PayloadEncoder TokenlessStream

newtype PacketEncoding pld Source #

Constructors

PacketEncoding (PayloadEncoder (PayloadStreaming pld))

class Show pld => Payload pld where Source #

Associated Types

type PayloadStreaming pld :: StreamType Source #

Methods

encodePayload :: pld -> PayloadEncoder (PayloadStreaming pld) Source #

Instances

Payload () Source #
Instance details Defined in Database.TDS.Proto Associated Types type PayloadStreaming () :: StreamType Source # Methods encodePayload :: () -> PayloadEncoder (PayloadStreaming ()) Source #
Payload Text Source #
Instance details Defined in Database.TDS.Proto Associated Types type PayloadStreaming Text :: StreamType Source # Methods encodePayload :: Text -> PayloadEncoder (PayloadStreaming Text) Source #
Payload Login7 Source #
Instance details Defined in Database.TDS.Proto Associated Types type PayloadStreaming Login7 :: StreamType Source # Methods encodePayload :: Login7 -> PayloadEncoder (PayloadStreaming Login7) Source #
Payload PreLogin Source #
Instance details Defined in Database.TDS.Proto Associated Types type PayloadStreaming PreLogin :: StreamType Source # Methods encodePayload :: PreLogin -> PayloadEncoder (PayloadStreaming PreLogin) Source #

runBatchEncoder :: Monoid fixup => Tardis fixup (Builder, Word) () -> PayloadEncoder TokenlessStream Source #

getFixups :: Tardis fixup (Builder, Word) fixup Source #

getPosition :: Tardis fixup (Builder, Word) Word Source #

fixup :: Monoid fixup => fixup -> Tardis fixup (Builder, Word) () Source #

emit :: Word -> Builder -> Tardis fixup (Builder, Word) () Source #

PRELOGIN Payload

newtype MajorVersion Source #

Constructors

MajorVersion Word8

Instances

Num MajorVersion Source #
Instance details Defined in Database.TDS.Proto Methods (+) :: MajorVersion -> MajorVersion -> MajorVersion # (-) :: MajorVersion -> MajorVersion -> MajorVersion # (*) :: MajorVersion -> MajorVersion -> MajorVersion # negate :: MajorVersion -> MajorVersion # abs :: MajorVersion -> MajorVersion # signum :: MajorVersion -> MajorVersion # fromInteger :: Integer -> MajorVersion #
Show MajorVersion Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> MajorVersion -> ShowS # show :: MajorVersion -> String # showList :: [MajorVersion] -> ShowS #

newtype MinorVersion Source #

Constructors

MinorVersion Word8

Instances

Num MinorVersion Source #
Instance details Defined in Database.TDS.Proto Methods (+) :: MinorVersion -> MinorVersion -> MinorVersion # (-) :: MinorVersion -> MinorVersion -> MinorVersion # (*) :: MinorVersion -> MinorVersion -> MinorVersion # negate :: MinorVersion -> MinorVersion # abs :: MinorVersion -> MinorVersion # signum :: MinorVersion -> MinorVersion # fromInteger :: Integer -> MinorVersion #
Show MinorVersion Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> MinorVersion -> ShowS # show :: MinorVersion -> String # showList :: [MinorVersion] -> ShowS #

newtype BuildNumber Source #

Constructors

BuildNumber Word16

Instances

Num BuildNumber Source #
Instance details Defined in Database.TDS.Proto Methods (+) :: BuildNumber -> BuildNumber -> BuildNumber # (-) :: BuildNumber -> BuildNumber -> BuildNumber # (*) :: BuildNumber -> BuildNumber -> BuildNumber # negate :: BuildNumber -> BuildNumber # abs :: BuildNumber -> BuildNumber # signum :: BuildNumber -> BuildNumber # fromInteger :: Integer -> BuildNumber #
Show BuildNumber Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> BuildNumber -> ShowS # show :: BuildNumber -> String # showList :: [BuildNumber] -> ShowS #

newtype SubBuildNumber Source #

Constructors

SubBuildNumber Word16

Instances

Num SubBuildNumber Source #
Instance details Defined in Database.TDS.Proto Methods (+) :: SubBuildNumber -> SubBuildNumber -> SubBuildNumber # (-) :: SubBuildNumber -> SubBuildNumber -> SubBuildNumber # (*) :: SubBuildNumber -> SubBuildNumber -> SubBuildNumber # negate :: SubBuildNumber -> SubBuildNumber # abs :: SubBuildNumber -> SubBuildNumber # signum :: SubBuildNumber -> SubBuildNumber # fromInteger :: Integer -> SubBuildNumber #
Show SubBuildNumber Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> SubBuildNumber -> ShowS # show :: SubBuildNumber -> String # showList :: [SubBuildNumber] -> ShowS #

data Encryption Source #

Constructors

EncryptionOff
EncryptionOn
EncryptionNotSupported
EncryptionRequired

Instances

Show Encryption Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> Encryption -> ShowS # show :: Encryption -> String # showList :: [Encryption] -> ShowS #

data Nonce Source #

Constructors

Nonce !Word64 !Word64 !Word64 !Word64

Instances

Show Nonce Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> Nonce -> ShowS # show :: Nonce -> String # showList :: [Nonce] -> ShowS #

data PreLoginOption Source #

Constructors

VersionOption !MajorVersion !MinorVersion !BuildNumber !SubBuildNumber
EncryptionOption !Encryption
InstanceNameOption !Text
ThreadIdOption !Word32
MarsOption !Bool
FedAuthRequiredOption !Word8
NonceOption !Nonce

Instances

Show PreLoginOption Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> PreLoginOption -> ShowS # show :: PreLoginOption -> String # showList :: [PreLoginOption] -> ShowS #

type PreLoginOptions = [PreLoginOption] Source #

versionOption :: MajorVersion -> MinorVersion -> BuildNumber -> SubBuildNumber -> PreLoginOptions Source #

encryptionOff :: PreLoginOptions Source #

newtype PreLogin Source #

Constructors

PreLoginP
Fields preLoginOptions :: PreLoginOptions

Instances

Show PreLogin Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> PreLogin -> ShowS # show :: PreLogin -> String # showList :: [PreLogin] -> ShowS #
Response PreLogin Source #
Instance details Defined in Database.TDS.Proto Associated Types type ResponseStreaming PreLogin :: StreamType Source # Methods responseDecoder :: ResponseDecoder (ResponseStreaming PreLogin) PreLogin Source #
Payload PreLogin Source #
Instance details Defined in Database.TDS.Proto Associated Types type PayloadStreaming PreLogin :: StreamType Source # Methods encodePayload :: PreLogin -> PayloadEncoder (PayloadStreaming PreLogin) Source #
type ResponseStreaming PreLogin Source #
Instance details Defined in Database.TDS.Proto type ResponseStreaming PreLogin = TokenlessStream
type PayloadStreaming PreLogin Source #
Instance details Defined in Database.TDS.Proto type PayloadStreaming PreLogin = TokenlessStream

LOGIN7 Payload

newtype TDSVersion Source #

Constructors

TDSVersion
Fields fromTDSVersion :: Word32

Instances

Show TDSVersion Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> TDSVersion -> ShowS # show :: TDSVersion -> String # showList :: [TDSVersion] -> ShowS #

newtype ClientProgVersion Source #

Constructors

ClientProgVersion
Fields fromClientProgVersion :: Word32

Instances

Show ClientProgVersion Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> ClientProgVersion -> ShowS # show :: ClientProgVersion -> String # showList :: [ClientProgVersion] -> ShowS #

newtype ClientPID Source #

Constructors

ClientPID
Fields fromClientPID :: Word32

Instances

Show ClientPID Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> ClientPID -> ShowS # show :: ClientPID -> String # showList :: [ClientPID] -> ShowS #

newtype ConnectionID Source #

Constructors

ConnectionID
Fields fromConnectionID :: Word32

Instances

Show ConnectionID Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> ConnectionID -> ShowS # show :: ConnectionID -> String # showList :: [ConnectionID] -> ShowS #

newtype Login7Options Source #

Constructors

Login7Options
Fields fromLogin7Options :: Word32

Instances

Show Login7Options Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> Login7Options -> ShowS # show :: Login7Options -> String # showList :: [Login7Options] -> ShowS #
Semigroup Login7Options Source #
Instance details Defined in Database.TDS.Proto Methods (<>) :: Login7Options -> Login7Options -> Login7Options # sconcat :: NonEmpty Login7Options -> Login7Options # stimes :: Integral b => b -> Login7Options -> Login7Options #
Monoid Login7Options Source #
Instance details Defined in Database.TDS.Proto Methods mempty :: Login7Options # mappend :: Login7Options -> Login7Options -> Login7Options # mconcat :: [Login7Options] -> Login7Options #

defaultLoginOptions :: Login7Options Source #

data Login7Feature Source #

Constructors

Login7Feature

Instances

Show Login7Feature Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> Login7Feature -> ShowS # show :: Login7Feature -> String # showList :: [Login7Feature] -> ShowS #

newtype LCID Source #

12-bit Windows language code identifier

Constructors

LCID Word16

Instances

Show LCID Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> LCID -> ShowS # show :: LCID -> String # showList :: [LCID] -> ShowS #

newtype CollationFlags Source #

Constructors

CollationFlags Word8

Instances

Show CollationFlags Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> CollationFlags -> ShowS # show :: CollationFlags -> String # showList :: [CollationFlags] -> ShowS #

newtype CollationVersion Source #

4-bit collation version

Constructors

CollationVersion Word8

Instances

Show CollationVersion Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> CollationVersion -> ShowS # show :: CollationVersion -> String # showList :: [CollationVersion] -> ShowS #

data Collation Source #

Constructors

Collation
Fields collationLCID :: !LCID collationFlags :: !CollationFlags collationVersion :: !CollationVersion

Instances

Show Collation Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> Collation -> ShowS # show :: Collation -> String # showList :: [Collation] -> ShowS #

data ClientID Source #

Constructors

ClientID !Word16 !Word32

Instances

Eq ClientID Source #
Instance details Defined in Database.TDS.Proto Methods (==) :: ClientID -> ClientID -> Bool # (/=) :: ClientID -> ClientID -> Bool #
Show ClientID Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> ClientID -> ShowS # show :: ClientID -> String # showList :: [ClientID] -> ShowS #

tdsVersion71 :: TDSVersion Source #

data Login7 Source #

Constructors

Login7P

Fields

login7_tdsVersion :: !TDSVersion
login7_packetSize :: !Word32
login7_clientProgVer :: !ClientProgVersion
login7_clientPID :: !ClientPID
login7_connectionID :: !ConnectionID
login7_flags :: !Login7Options
login7_clientTmZone :: !Word32
login7_collation :: !Collation
login7_hostName :: !Text
login7_userName :: !Text
login7_password :: !Text
login7_appName :: !Text
login7_serverName :: !Text
login7_extension :: !Text
login7_cltIntName :: !Text
login7_language :: !Text
login7_database :: !Text
login7_clientID :: !ClientID
login7_SSPI :: !Text
login7_atchDbFile :: !Text
login7_changePasswd :: !Text
login7_SSPILong :: !Word32
login7_extraFeatures :: [Login7Feature]

Instances

Show Login7 Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> Login7 -> ShowS # show :: Login7 -> String # showList :: [Login7] -> ShowS #
Payload Login7 Source #
Instance details Defined in Database.TDS.Proto Associated Types type PayloadStreaming Login7 :: StreamType Source # Methods encodePayload :: Login7 -> PayloadEncoder (PayloadStreaming Login7) Source #
type PayloadStreaming Login7 Source #
Instance details Defined in Database.TDS.Proto type PayloadStreaming Login7 = TokenlessStream

data Login7Fixups Source #

Constructors

Login7Fixups

Fields

login7_totalLen :: !(Sum Word32)
login7_hostNameOfs :: !Word16
login7_userNameOfs :: !Word16
login7_passwordOfs :: !Word16
login7_appNameOfs :: !Word16
login7_serverNameOfs :: !Word16
login7_extensionOfs :: !Word16
login7_cltIntNameOfs :: !Word16
login7_languageOfs :: !Word16
login7_databaseOfs :: !Word16
login7_SSPIOfs :: !Word16
login7_atchDbFileOfs :: !Word16
login7_changePasswdOfs :: !Word16

Instances

Show Login7Fixups Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> Login7Fixups -> ShowS # show :: Login7Fixups -> String # showList :: [Login7Fixups] -> ShowS #
Semigroup Login7Fixups Source #
Instance details Defined in Database.TDS.Proto Methods (<>) :: Login7Fixups -> Login7Fixups -> Login7Fixups # sconcat :: NonEmpty Login7Fixups -> Login7Fixups # stimes :: Integral b => b -> Login7Fixups -> Login7Fixups #
Monoid Login7Fixups Source #
Instance details Defined in Database.TDS.Proto Methods mempty :: Login7Fixups # mappend :: Login7Fixups -> Login7Fixups -> Login7Fixups # mconcat :: [Login7Fixups] -> Login7Fixups #

Packet decoders

data ResponseDecoder (streaming :: StreamType) (res :: *) where Source #

Constructors

DecodeBatchResponse :: (Ptr Word8 -> Word16 -> IO (Maybe res)) -> ResponseDecoder TokenlessStream res
DecodeTokenStream :: (forall r. IO () -> Stream TokenStream IO r -> IO res) -> ResponseDecoder TokenStream res

class Show res => Response res where Source #

Associated Types

type ResponseStreaming res :: StreamType Source #

Methods

responseDecoder :: ResponseDecoder (ResponseStreaming res) res Source #

Instances

Response RowResults Source #
Instance details Defined in Database.TDS.Proto Associated Types type ResponseStreaming RowResults :: StreamType Source # Methods responseDecoder :: ResponseDecoder (ResponseStreaming RowResults) RowResults Source #
Response Login7Ack Source #
Instance details Defined in Database.TDS.Proto Associated Types type ResponseStreaming Login7Ack :: StreamType Source # Methods responseDecoder :: ResponseDecoder (ResponseStreaming Login7Ack) Login7Ack Source #
Response PreLogin Source #
Instance details Defined in Database.TDS.Proto Associated Types type ResponseStreaming PreLogin :: StreamType Source # Methods responseDecoder :: ResponseDecoder (ResponseStreaming PreLogin) PreLogin Source #
Response Unimplemented Source #
Instance details Defined in Database.TDS.Proto Associated Types type ResponseStreaming Unimplemented :: StreamType Source # Methods responseDecoder :: ResponseDecoder (ResponseStreaming Unimplemented) Unimplemented Source #

type BatchDecoder = StateT (Ptr Word8, Word16) (ReaderT Word16 (MaybeT IO)) Source #

decodeBatch :: BatchDecoder a -> ResponseDecoder TokenlessStream a Source #

read8 :: BatchDecoder Word8 Source #

read16BE :: BatchDecoder Word16 Source #

read32BE :: BatchDecoder Word32 Source #

read64BE :: BatchDecoder Word64 Source #

read16LE :: BatchDecoder Word16 Source #

read32LE :: BatchDecoder Word32 Source #

read64LE :: BatchDecoder Word64 Source #

ztText :: Word16 -> BatchDecoder Text Source #

tell :: BatchDecoder Word16 Source #

seek :: Word16 -> BatchDecoder () Source #

PRELOGIN response

data Login7Ack Source #

Constructors

Login7Ack !Word8 !TDSVersion !Text !ProgVersion

Instances

Show Login7Ack Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> Login7Ack -> ShowS # show :: Login7Ack -> String # showList :: [Login7Ack] -> ShowS #
Response Login7Ack Source #
Instance details Defined in Database.TDS.Proto Associated Types type ResponseStreaming Login7Ack :: StreamType Source # Methods responseDecoder :: ResponseDecoder (ResponseStreaming Login7Ack) Login7Ack Source #
type ResponseStreaming Login7Ack Source #
Instance details Defined in Database.TDS.Proto type ResponseStreaming Login7Ack = TokenStream

Tokens

newtype DoneSts Source #

Constructors

DoneSts Word16

Instances

Show DoneSts Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> DoneSts -> ShowS # show :: DoneSts -> String # showList :: [DoneSts] -> ShowS #

newtype ProgVersion Source #

Constructors

ProgVersion Word32

Instances

Show ProgVersion Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> ProgVersion -> ShowS # show :: ProgVersion -> String # showList :: [ProgVersion] -> ShowS #

data Message Source #

Constructors

Message
Fields messageCode :: !SQLError messageSt :: !Word8 messageClass :: !ErrorClass messageText :: !Text messageServerName :: !Text messageProcName :: !Text messageLineNum :: Word16

Instances

Show Message Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
Exception Message Source #
Instance details Defined in Database.TDS.Proto Methods toException :: Message -> SomeException # fromException :: SomeException -> Maybe Message # displayException :: Message -> String #

data EnvChange Source #

Constructors

EnvChangeDatabase !Text !Text
EnvChangeLanguage !Text !Text
EnvChangeCollation !ByteString !ByteString
EnvChangeUnknown

Instances

Show EnvChange Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> EnvChange -> ShowS # show :: EnvChange -> String # showList :: [EnvChange] -> ShowS #

data Token' f Source #

Instances

Functor Token' Source #
Instance details Defined in Database.TDS.Proto Methods fmap :: (a -> b) -> Token' a -> Token' b # (<$) :: a -> Token' b -> Token' a #
Show f => Show (Token' f) Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> Token' f -> ShowS # show :: Token' f -> String # showList :: [Token' f] -> ShowS #

type Token = Token' (ByteString IO ()) Source #

data TokenStream f Source #

Constructors

OneToken !Token f
ContParse !Token (ByteString IO () -> f)

Instances

Functor TokenStream Source #
Instance details Defined in Database.TDS.Proto Methods fmap :: (a -> b) -> TokenStream a -> TokenStream b # (<$) :: a -> TokenStream b -> TokenStream a #

doneHasMore :: DoneSts -> Bool Source #

doneHasError :: DoneSts -> Bool Source #

parseTokenStream :: ByteString IO () -> Stream TokenStream IO () Source #

usVarChar :: Parser (Int, Text) Source #

bVarChar :: Parser (Int, Text) Source #

bVarByte :: Parser (Int, ByteString) Source #

parseToken :: Parser (Either (ByteString IO () -> Token) Token) Source #

Tabular results

data EncryptionAlgorithm Source #

Constructors

EncryptionAlgorithm

Instances

Show EncryptionAlgorithm Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> EncryptionAlgorithm -> ShowS # show :: EncryptionAlgorithm -> String # showList :: [EncryptionAlgorithm] -> ShowS #

data EncryptionAlgorithmType Source #

Constructors

EncryptionAlgorithmType

Instances

Show EncryptionAlgorithmType Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> EncryptionAlgorithmType -> ShowS # show :: EncryptionAlgorithmType -> String # showList :: [EncryptionAlgorithmType] -> ShowS #

data CharKind Source #

Constructors

NormalChar
NationalChar

Instances

Show CharKind Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> CharKind -> ShowS # show :: CharKind -> String # showList :: [CharKind] -> ShowS #

data PrecScale Source #

Constructors

PrecScale !Word8 !Word8

Instances

Show PrecScale Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> PrecScale -> ShowS # show :: PrecScale -> String # showList :: [PrecScale] -> ShowS #

data TypeLen Source #

Constructors

ByteLen
ShortLen

Instances

Show TypeLen Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> TypeLen -> ShowS # show :: TypeLen -> String # showList :: [TypeLen] -> ShowS #

data TypeInfo Source #

Constructors

NullType
IntNType !Bool !Word8
GuidType !Word8
DecimalType !Bool !Word8 !PrecScale
NumericType !Bool !Word8 !PrecScale
BitNType !Bool !Word8
DecimalNType !Bool !Word8 !PrecScale
NumericNType !Bool !Word8 !PrecScale
FloatNType !Bool !Word8
MoneyNType !Bool !Word8
DtTmNType !Bool !Word8
DateNType !Bool !Word8
TimeNType !Bool !Word8
DtTm2NType !Word8
DtTmOfsType !Word8
CharType !TypeLen !CharKind !Word16 !(Maybe Collation)
VarcharType !TypeLen !CharKind !Word16 !(Maybe Collation)
BinaryType !Word16
VarBinType !Word16
ImageType !Word32
NTextType !Word32 !Collation
SSVarType !Word32
TextType !Word32 !Collation
XMLType !Word32

Instances

Show TypeInfo Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> TypeInfo -> ShowS # show :: TypeInfo -> String # showList :: [TypeInfo] -> ShowS #

data CryptoMetadata Source #

Constructors

CryptoMetadata
Fields cryptoOrdinal :: !Word16 cryptoUserType :: !Word32 cryptoBaseType :: !TypeInfo cryptoEncAlgo :: !EncryptionAlgorithm cryptoAlgName :: !Text cryptoAlgType :: !EncryptionAlgorithmType cryptoNormVers :: !Word8

Instances

Show CryptoMetadata Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> CryptoMetadata -> ShowS # show :: CryptoMetadata -> String # showList :: [CryptoMetadata] -> ShowS #

data ColumnData Source #

Constructors

ColumnData
Fields cdUserType :: !Word32 cdFlags :: !Word16 cdBaseTypeInfo :: !TypeInfo cdTableName :: !(Maybe Text) cdCrypto :: !(Maybe CryptoMetadata) cdColName :: !Text

Instances

Show ColumnData Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> ColumnData -> ShowS # show :: ColumnData -> String # showList :: [ColumnData] -> ShowS #

data ColumnMetadata Source #

Constructors

ColumnMetadata
Fields cmCekTbl :: ByteString cmColData :: [ColumnData]

Instances

Show ColumnMetadata Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> ColumnMetadata -> ShowS # show :: ColumnMetadata -> String # showList :: [ColumnMetadata] -> ShowS #

data RawColumn f where Source #

Constructors

RawColumn :: ColumnData -> ByteString IO () -> (ByteString IO () -> f) -> RawColumn f

Instances

Functor RawColumn Source #
Instance details Defined in Database.TDS.Proto Methods fmap :: (a -> b) -> RawColumn a -> RawColumn b # (<$) :: a -> RawColumn b -> RawColumn a #

typeInfoParser :: Parser TypeInfo Source #

colDataParser :: Parser ColumnData Source #

colMetadataP :: Parser ColumnMetadata Source #

newtype RowResults Source #

Constructors

RowResults
Fields getRowResults :: Stream (Compose (Of ColumnMetadata) (Stream (Stream RawColumn IO) IO)) IO ()

Instances

Show RowResults Source #
Instance details Defined in Database.TDS.Proto Methods showsPrec :: Int -> RowResults -> ShowS # show :: RowResults -> String # showList :: [RowResults] -> ShowS #
Response RowResults Source #
Instance details Defined in Database.TDS.Proto Associated Types type ResponseStreaming RowResults :: StreamType Source # Methods responseDecoder :: ResponseDecoder (ResponseStreaming RowResults) RowResults Source #
type ResponseStreaming RowResults Source #
Instance details Defined in Database.TDS.Proto type ResponseStreaming RowResults = TokenStream

Splitting packets

data SplitEncoding sender resp pld Source #

Constructors

LastPacket (Ptr () -> IO CSize)
OnePacket (Ptr () -> IO (Packet sender resp pld (SplitEncoding sender resp)))

type SplitPacket sender resp pld = Packet sender resp pld (SplitEncoding sender resp) Source #

splitPacket :: CSize -> Packet Client resp d PacketEncoding -> (Maybe CSize, SplitPacket Client resp d) Source #

KnownBool type class

class KnownBool (b :: Bool) where Source #

Methods

boolVal :: p b -> Bool Source #

Instances

KnownBool False Source #
Instance details Defined in Database.TDS.Proto Methods boolVal :: p False -> Bool Source #
KnownBool True Source #
Instance details Defined in Database.TDS.Proto Methods boolVal :: p True -> Bool Source #

PreLogin :: PacketType Client (ExpectsResponse (ResponseType False PreLogin)) PreLogin
Login7 :: PacketType Client (ExpectsResponse (ResponseType False Login7Ack)) Login7
SQLBatch :: PacketType Client (ExpectsResponse (ResponseType True RowResults)) Text
BulkLoad :: PacketType Client NoResponse Unimplemented
RPC :: PacketType Client NoResponse Unimplemented
Attention :: PacketType Client (ExpectsResponse (ResponseType False ())) ()
TrMgrRequest :: PacketType Client NoResponse Unimplemented
TabularResult :: PacketType Server NoResponse a

TvpRow
Offset
ReturnStatus
ColMetadata !ColumnMetadata
AltMetadata
TableName
ColumnInfo
Order (Vector Word8)
Error !Message
Info !Message
ReturnValue
LoginAck !Word8 !TDSVersion !Text !ProgVersion
FeatureExtAck
Row !f
NbcRow
AltRow
EnvChange !EnvChange
SessionState
SSPI
FedAuthInfo
Done !DoneSts !Word16 !Word64
DoneProc
DoneInProc