mssql

README

mssql

Microsoft SQL Server adapter for REL.

Example

package main

import (
	"context"

	_ "github.com/microsoft/go-mssqldb"
	"github.com/go-rel/mssql"
	"github.com/go-rel/rel"
)

func main() {
	// open mssql connection.
	adapter, err := mssql.Open("sqlserver://sa:REL2021-mssql@localhost:1433?database=rel")
	if err != nil {
		panic(err)
	}
	defer adapter.Close()

	// initialize REL's repo.
	repo := rel.New(adapter)
	repo.Ping(context.TODO())
}

Supported Driver

• github.com/microsoft/go-mssqldb
• github.com/denisenkom/go-mssqldb

Supported Database

• Microsoft SQL Server 2017
• Microsoft SQL Server 2019

Testing

Start Microsoft SQL server in Docker

docker run -it --rm -p 1434:1433 -e "ACCEPT_EULA=Y" -e "SA_PASSWORD=REL2021-mssql" -e "MSSQL_PID=Developer"  mcr.microsoft.com/mssql/server:2019-latest

Run tests

MSSQL_DATABASE="sqlserver://sa:REL2021-mssql@localhost:1434" go test ./...

Documentation

Overview

Package mssql wraps mssql driver as an adapter for REL.

Example

package main

import (
	"context"

	"github.com/go-rel/mssql"
	"github.com/go-rel/rel"

	_ "github.com/microsoft/go-mssqldb"
)

func main() {
	// open mssql connection.
	adapter, err := mssql.Open("sqlserver://sa:REL2021-mssql@localhost:1433?database=rel")
	if err != nil {
		panic(err)
	}
	defer adapter.Close()

	// initialize REL's repo.
	repo := rel.New(adapter)
	repo.Ping(context.TODO())
}

Index

• Constants
• func MustOpen(dsn string) rel.Adapter
• func New(db *db.DB) rel.Adapter
• func Open(dsn string) (rel.Adapter, error)
• type MSSQL
  • func (m MSSQL) Begin(ctx context.Context) (rel.Adapter, error)
  • func (m MSSQL) Insert(ctx context.Context, query rel.Query, primaryField string, ...) (interface{}, error)
  • func (m MSSQL) InsertAll(ctx context.Context, query rel.Query, primaryField string, fields []string, ...) ([]interface{}, error)
  • func (MSSQL) Name() string

Examples

• Package

Constants

const Name string = "mssql"

Name of database type this adapter implements.

Functions

func MustOpen

func MustOpen(dsn string) rel.Adapter

MustOpen mssql connection using dsn.

func New

func New(db *db.DB) rel.Adapter

New mssql adapter using existing connection.

func Open

func Open(dsn string) (rel.Adapter, error)

Open mssql connection using dsn.

Types

type MSSQL

type MSSQL struct {
	sql.SQL
}

MSSQL Adapter.

func (MSSQL) Begin

func (m MSSQL) Begin(ctx context.Context) (rel.Adapter, error)

Begin begins a new transaction.

func (MSSQL) Insert

func (m MSSQL) Insert(ctx context.Context, query rel.Query, primaryField string, mutates map[string]rel.Mutate, onConflict rel.OnConflict) (interface{}, error)

Insert inserts a record to database and returns its id.

func (MSSQL) InsertAll

func (m MSSQL) InsertAll(ctx context.Context, query rel.Query, primaryField string, fields []string, bulkMutates []map[string]rel.Mutate, onConflict rel.OnConflict) ([]interface{}, error)

InsertAll inserts multiple records to database and returns its ids.

func (MSSQL) Name

func (MSSQL) Name() string

Name of database adapter.