tamate

README

tamate

A library to handle table-based data generically.

---

• Features
• Requirements
• Support Drivers
• Installation
• Usage
  • DataSource
    • DSN
• Testing / Development
• License

---

Features

• Unification of ambiguous names like left/right
• Goroutine safe
• GetRows returns iterator
• Support TSV
• Support SQLite
• Support PostgleSQL

Requirements

• Go 1.12 or higher. We aim to support the 3 latest versions of Go.

Support Drivers

• CSV
• Spreadsheet
• MySQL
• Spanner

---

Installation

Simple install the package to your $GOPATH with the go tool from shell:

$ go get -u github.com/Mitu217/tamate

Make sure Git is installed on your machine and in your system's PATH.

Usage

Tamate Driver is an implementation of tamate/driver interface.

Use csv as driverName and a valid DSN as dataSourceName:

import  "github.com/Mitu217/tamate"
import  _ "github.com/Mitu217/tamate-csv"

ds, err := tamate.Open("csv", "./")

DataSource

DataSource represents the connection destination where table-based data supported by Tamate.

Use this to Get, Set, GettingDiff, etc.

DSN (Data Source Name)

DSN is not only common format such as used in database/sql.

Please refer to the usage of the driver to use.

Testing / Development

Please execute the following command at the root of the project

go test ./...

---

License

• MIT
  • see LICENSE

Documentation

Index

• func Drivers() map[string]driver.Driver
• func Register(name string, driver driver.Driver)
• type DataSource
  • func Open(name string, dsn string) (*DataSource, error)
  • func OpenDataSource(connector driver.Connector) *DataSource
  • func (ds *DataSource) Close() error
  • func (ds *DataSource) GetRows(ctx context.Context, name string) ([]*driver.Row, error)
  • func (ds *DataSource) GetSchema(ctx context.Context, name string) (*driver.Schema, error)
  • func (ds *DataSource) SetRows(ctx context.Context, name string, rows []*driver.Row) error
  • func (ds *DataSource) SetSchema(ctx context.Context, name string, schema *driver.Schema) error

Functions

func Drivers

func Drivers() map[string]driver.Driver

func Register

func Register(name string, driver driver.Driver)

Types

type DataSource

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

func Open

func Open(name string, dsn string) (*DataSource, error)

func OpenDataSource

func OpenDataSource(connector driver.Connector) *DataSource

func (*DataSource) Close

func (ds *DataSource) Close() error

func (*DataSource) GetRows

func (ds *DataSource) GetRows(ctx context.Context, name string) ([]*driver.Row, error)

func (*DataSource) GetSchema

func (ds *DataSource) GetSchema(ctx context.Context, name string) (*driver.Schema, error)

func (*DataSource) SetRows

func (ds *DataSource) SetRows(ctx context.Context, name string, rows []*driver.Row) error

func (*DataSource) SetSchema

func (ds *DataSource) SetSchema(ctx context.Context, name string, schema *driver.Schema) error