README
¶
dapi
dapi is a Go sql.Driver for the AWS RDS Data API
Motivation
I wanted to the productivity of using gorm combined with the utility of
convenience of the RDS Data API. Looking around, I couldn't find anything that fit
the bill and hence, dapi
QuickStart
dapi is intended to work as a standard golang sql.Driver and specifically as a driver
usable by gorm
func main() {
var (
s = session.Must(session.NewSession(aws.NewConfig()))
api = rdsdataservice.New(s)
driver = dapi.New(api)
database = "the database name"
secretARN = "secret arn holding database credentials"
resourceARN = "resource arn"
dsn = fmt.Sprintf("secret=%v resource=%v database=%v", secretARN, resourceARN, database)
dialect = "mysql"
)
sql.Register(dialect, driver)
db, err := gorm.Open(dialect, dsn)
// at this point you can use gorm as you normally would
}
Maturity
This project is very new and should not be used for production. Your mileage may vary.
Documentation
¶
Index ¶
- func New(api rdsdataserviceiface.RDSDataServiceAPI) driver.Driver
- type Conn
- func (c *Conn) Begin() (driver.Tx, error)
- func (c *Conn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, error)
- func (c *Conn) Close() error
- func (c *Conn) ExecContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Result, error)
- func (c *Conn) Prepare(query string) (driver.Stmt, error)
- func (c *Conn) PrepareContext(ctx context.Context, query string) (driver.Stmt, error)
- func (c *Conn) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Rows, error)
- type Connector
- type Driver
- type Result
- type Stmt
- func (s *Stmt) Close() error
- func (s *Stmt) Exec(args []driver.Value) (driver.Result, error)
- func (s *Stmt) ExecContext(ctx context.Context, args []driver.NamedValue) (driver.Result, error)
- func (s *Stmt) NumInput() int
- func (s *Stmt) Query(args []driver.Value) (driver.Rows, error)
- func (s *Stmt) QueryContext(ctx context.Context, args []driver.NamedValue) (driver.Rows, error)
- type Tx
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func New ¶
func New(api rdsdataserviceiface.RDSDataServiceAPI) driver.Driver
Types ¶
type Conn ¶
type Conn struct {
// contains filtered or unexported fields
}
func (*Conn) ExecContext ¶
func (*Conn) PrepareContext ¶
type Result ¶
type Result struct {
// contains filtered or unexported fields
}
func (*Result) LastInsertId ¶
func (*Result) RowsAffected ¶
type Stmt ¶
type Stmt struct {
// contains filtered or unexported fields
}
func (*Stmt) ExecContext ¶
func (*Stmt) NumInput ¶
NumInput returns the number of placeholder parameters.
If NumInput returns >= 0, the sql package will sanity check argument counts from callers and return errors to the caller before the statement's Exec or Query methods are called.
NumInput may also return -1, if the driver doesn't know its number of placeholders. In that case, the sql package will not sanity check Exec or Query argument counts.
Source Files