ms

package
v1.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 23, 2026 License: Zlib Imports: 27 Imported by: 0

README 

# Microsoft SQL Server (MS SQL Server) TDS database client.
Database driver for database client frontend:
 http://godoc.org/github.com/kardianos/rdb

Documentation

Overview

Microsoft SQL Server (MS SQL Server) TDS Protocol database client.

For use with sql client interface: 

github.com/kardianos/rdb

This driver doesn't use cgo or any c libraries and is self contained.

Supported Data Types 

rdb.
	TypeNull

	TypeString     :: Maps to nvarchar
	TypeAnsiString :: Maps to varchar
	TypeBinary     :: Maps to varbinary

	TypeText
	TypeAnsiText
	TypeVarChar
	TypeAnsiVarChar
	TypeChar
	TypeAnsiChar

	TypeBool
	TypeInt8
	TypeInt16
	TypeInt32
	TypeInt64

	TypeFloat32
	TypeFloat64

	TypeDecimal

	TypeTDZ
	TypeTime
	TypeDate
	TypeTD   :: Maps to DateTime2

tds.
	TypeOldTD :: Maps to DateTime

The following types support io.Writer for output fields, and io.Reader for input parameters: 

TypeString
TypeAnsiString
TypeBinary
TypeVarChar
TypeAnsiVarChar

Transactions are not yet supported.

Out parameters are not yet supported.

Parameter names are not optional. They must be supplied.

TEXTSIZE Limit

SQL Server has a server-side TEXTSIZE setting that controls the maximum number of bytes returned for varchar(max), nvarchar(max), varbinary(max), text, ntext, and image columns. The default TEXTSIZE is 4096 bytes, which may truncate large data.

To prevent truncation, set TEXTSIZE in your connection's ResetQuery configuration: 

config := &rdb.Config{
	// ... other settings ...
	ResetQuery: "SET TEXTSIZE 2147483647",
}

Reference: https://learn.microsoft.com/en-us/sql/t-sql/statements/set-textsize-transact-sql

Index

Constants

View Source 
const (
	TypeOldBool rdb.Type = rdb.TypeDriverThresh + iota
	TypeOldByte
	TypeOldInt16
	TypeOldInt32
	TypeOldInt64
	TypeOldFloat32
	TypeOldFloat64
	TypeOldTD // DateTime
	TypeNumeric
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Bulk added in v1.2.0 

type Bulk struct {
	CheckConstraints bool
	FireTriggers     bool
	KeepNulls        bool
	TabLock          bool
	KBPerBatch       int
	RowsPerBatch     int

	TableName string
	Columns   []rdb.Param

	Row func(row []rdb.Param) error
}

func (*Bulk) Next added in v1.2.0 

func (b *Bulk) Next(batchCount int, row []rdb.Param) error

func (*Bulk) Start added in v1.2.0 

func (b *Bulk) Start() (sql string, col []rdb.Param, err error)

type Connection 

type Connection struct {
	ProductVersion  *semver.Version
	ProtocolVersion *semver.Version
	Encrypted       bool
	// contains filtered or unexported fields
}

func NewConnection 

func NewConnection(c net.Conn, defaultResetTimeout, RollbackTimeout time.Duration) *Connection

func (*Connection) Available 

func (tds *Connection) Available() bool

func (*Connection) Begin 

func (tds *Connection) Begin(ctx context.Context, iso rdb.IsolationLevel) error

func (*Connection) Close 

func (tds *Connection) Close()

func (*Connection) Commit 

func (tds *Connection) Commit(ctx context.Context) error

func (*Connection) ConnectionInfo 

func (tds *Connection) ConnectionInfo() *rdb.ConnectionInfo

func (*Connection) NextQuery 

func (tds *Connection) NextQuery(ctx context.Context) (err error)

func (*Connection) NextResult 

func (tds *Connection) NextResult(ctx context.Context) (more bool, err error)

func (*Connection) Open 

func (tds *Connection) Open(ctx context.Context, config *rdb.Config) (*ServerInfo, error)

func (*Connection) OpenTDS8 added in v1.3.0 

func (tds *Connection) OpenTDS8(ctx context.Context, config *rdb.Config) (*ServerInfo, error)

OpenTDS8 opens a connection using TDS 8.0 protocol. TDS 8.0 establishes TLS before any TDS messages, using ALPN for protocol negotiation.

func (*Connection) Opened added in v1.0.4 

func (tds *Connection) Opened() time.Time

func (*Connection) Prepare 

func (tds *Connection) Prepare(*rdb.Command) (preparedStatementToken interface{}, err error)

func (*Connection) Query 

func (tds *Connection) Query(ctx context.Context, cmd *rdb.Command, params []rdb.Param, preparedToken interface{}, valuer rdb.DriverValuer) error

func (*Connection) Reset 

func (tds *Connection) Reset(c *rdb.Config) error

func (*Connection) Rollback 

func (tds *Connection) Rollback(savepoint string) error

func (*Connection) SavePoint 

func (tds *Connection) SavePoint(ctx context.Context, name string) error

func (*Connection) Scan 

func (tds *Connection) Scan(ctx context.Context) error

func (*Connection) SetAvailable 

func (tds *Connection) SetAvailable(available bool)

func (*Connection) Status 

func (tds *Connection) Status() rdb.DriverConnStatus

func (*Connection) Unprepare 

func (tds *Connection) Unprepare(preparedStatementToken interface{}) (err error)

type Driver 

type Driver struct{}

func (*Driver) DriverInfo 

func (dr *Driver) DriverInfo() *rdb.DriverInfo

func (*Driver) Open 

func (dr *Driver) Open(ctx context.Context, c *rdb.Config) (rdb.DriverConn, error)

func (*Driver) PingCommand 

func (db *Driver) PingCommand() *rdb.Command

type EncryptAvailable 

type EncryptAvailable byte

type InputToolong 

type InputToolong struct {
	DataLen, TypeLen uint32
}

func (InputToolong) Error 

func (err InputToolong) Error() string

type MessageReader 

type MessageReader struct {
	// contains filtered or unexported fields
}

func (*MessageReader) Close 

func (mr *MessageReader) Close() error

func (*MessageReader) Fetch 

func (r *MessageReader) Fetch(ctx context.Context, n int) (ret []byte, err error)

func (*MessageReader) FetchAll 

func (r *MessageReader) FetchAll(ctx context.Context) (ret []byte, err error)

func (*MessageReader) Next 

func (mr *MessageReader) Next(ctx context.Context) ([]byte, error)

Read another packet.

func (*MessageReader) PeekByte added in v1.2.1 

func (r *MessageReader) PeekByte(ctx context.Context) (out byte, err error)

type MsgCancel added in v1.1.0 

type MsgCancel struct {
	IsAttention   bool
	IsServerError bool
	IsError       bool
}

type MsgColumn 

type MsgColumn struct{}

type MsgDone 

type MsgDone struct {
	StatusCode uint16
	CurrentCmd uint16
	Rows       uint64
}

func (MsgDone) Error 

func (done MsgDone) Error() string

func (MsgDone) Status 

func (done MsgDone) Status() string

func (MsgDone) String 

func (done MsgDone) String() string

type MsgEnvChange 

type MsgEnvChange struct{}

type MsgEom 

type MsgEom struct{}

type MsgFinalDone 

type MsgFinalDone struct{}

type MsgOrder 

type MsgOrder []uint16

type MsgOther 

type MsgOther struct {
	Other interface{}
}

type MsgParamValue 

type MsgParamValue struct{}

type MsgRow 

type MsgRow struct{}

type MsgRowCount 

type MsgRowCount struct {
	Count uint64
}

type MsgRpcResult 

type MsgRpcResult int32

type MsgStatus 

type MsgStatus byte

type PacketReader 

type PacketReader struct {
	// contains filtered or unexported fields
}

func NewPacketReader 

func NewPacketReader(r sbuffer.ConnReadDeadline) *PacketReader

func (*PacketReader) BeginMessage 

func (tds *PacketReader) BeginMessage(_ context.Context, expectType PacketType) *MessageReader

func (*PacketReader) LoginAck 

func (tds *PacketReader) LoginAck(ctx context.Context) (*ServerInfo, error)

func (*PacketReader) Prelogin 

func (tds *PacketReader) Prelogin(ctx context.Context) (*ServerConnection, error)

type PacketType 

type PacketType byte

type PacketWriter 

type PacketWriter struct {
	PacketType PacketType
	// contains filtered or unexported fields
}

func NewPacketWriter 

func NewPacketWriter(w connWriteDeadline) *PacketWriter

func (*PacketWriter) BeginMessage 

func (tds *PacketWriter) BeginMessage(ctx context.Context, PacketType PacketType, reset bool) error

func (*PacketWriter) EndMessage 

func (tds *PacketWriter) EndMessage(ctx context.Context) error

func (*PacketWriter) Login 

func (tds *PacketWriter) Login(ctx context.Context, config *rdb.Config) error

Write LOGIN7. Page 53.

func (*PacketWriter) PreLogin 

func (tds *PacketWriter) PreLogin(ctx context.Context, instance string, encrypt EncryptAvailable) error

Pre-Login

func (*PacketWriter) Write 

func (tds *PacketWriter) Write(ctx context.Context, bb []byte) (n int, err error)

func (*PacketWriter) WriteBuffer 

func (tds *PacketWriter) WriteBuffer(v []byte) (n int)

func (*PacketWriter) WriteByte 

func (tds *PacketWriter) WriteByte(v byte) (n int)

func (*PacketWriter) WriteUint16 

func (tds *PacketWriter) WriteUint16(v uint16) (n int)

func (*PacketWriter) WriteUint32 

func (tds *PacketWriter) WriteUint32(v uint32) (n int)

func (*PacketWriter) WriteUint64 

func (tds *PacketWriter) WriteUint64(v uint64) (n int)

type SQLColumn added in v1.2.0 

type SQLColumn struct {
	rdb.Column

	Collation [5]byte
	// contains filtered or unexported fields
}

type ServerConnection 

type ServerConnection struct {
	Version    [6]byte
	Encryption EncryptAvailable
	Instance   string
	MARS       bool
}

Rturned from Pre-Login.

type ServerInfo 

type ServerInfo struct {
	AcceptTSql  bool
	TdsVersion  [4]byte
	ProgramName string

	MajorVersion byte
	MinorVersion byte
	BuildNumber  uint16
}

Returned from Login.

func (*ServerInfo) String 

func (si *ServerInfo) String() string

type UnexpectedMessage 

type UnexpectedMessage struct {
	Expected PacketType
	Received PacketType
}

func (UnexpectedMessage) Error 

func (msg UnexpectedMessage) Error() string

Source Files

View all Source files

Directories

Path Synopsis
Package batch functions for interacting with batched sql statements in the same file or string.
 Package batch functions for interacting with batched sql statements in the same file or string.
internal
testcert
Package testcert provides utilities for generating self-signed TLS certificates for testing purposes.
 Package testcert provides utilities for generating self-signed TLS certificates for testing purposes.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.