cmd

README

Command line datly executor

./datly -h

Generate rule with endpoint for a table

 ./datly  -C=dev  -N=MyViewName -T=MyTableName
 
open http://127.0.0.1:8080/v1/api/dev/MyViewName

Generate rule with endpoint for a table and SQL

 ./datly  -C=dev  -N=MyViewName -T=MyTableName -S=view.sql

 ./datly  -C=dev  -N=MyViewName -T=MyTableName

Generate rule with endpoint for a table and relations

 ./datly  -C=dev  -N=MyViewName -T=MyTableName  -R=MyRelName:RelTable 

SQLx (extension) based rule generation

One to many

rule.sql

SELECT 
    dept.*
    employee.*
FROM DEPARMENT dept
JOIN EMP employee ON dept.ID = employee.DEPT_ID 

datly -N=dept -X=rule.sql

One to one relation

rule.sql

SELECT 
    dept.*
    employee.*,
    organization.*
FROM DEPARMENT dept
JOIN EMP employee ON dept.ID = employee.DEPT_ID
JOIN ORG organization ON organization.ID = demp.ORG_ID AND 1=1

datly -N=dept -X=rule.sql

Excluding output column

rule.sql

SELECT 
    dept.* EXCEPT ORG_ID
    employee.* EXCEPT DEPT_ID, 
    organization.* 
FROM DEPARMENT dept
JOIN EMP employee ON dept.ID = employee.DEPT_ID
JOIN ORG organization ON organization.ID = demp.ORG_ID AND 1=1

datly -N=dept -X=rule.sql

View SQL

rule.sql

SELECT 
    dept.* EXCEPT ORG_ID
    employee.* EXCEPT DEPT_ID, 
    organization.* 
FROM (SELECT * FROM DEPARMENT t) dept
JOIN (SELECT ID, NAME, DEPT_ID FROM EMP t) employee ON dept.ID = employee.DEPT_ID
JOIN ORG organization ON organization.ID = demp.ORG_ID AND 1=1

datly -N=dept -X=rule.sql

View SQL with velty template and query parameters

SELECT 
    dept.* EXCEPT ORG_ID
    employee.* EXCEPT DEPT_ID, 
    organization.* 
FROM (SELECT * FROM DEPARMENT t) dept
JOIN (SELECT ID, NAME, DEPT_ID FROM EMP t) employee ON dept.ID = employee.DEPT_ID
JOIN ORG organization ON organization.ID = demp.ORG_ID AND 1=1
WHERE 1=1
#if ($Has.Id)
AND ID = $Id
#end

View SQL with query parameters

SELECT 
    dept.* EXCEPT ORG_ID
    employee.* EXCEPT DEPT_ID, 
    organization.* 
FROM (SELECT * FROM DEPARMENT t) dept
JOIN (SELECT ID, NAME, DEPT_ID FROM EMP t) employee ON dept.ID = employee.DEPT_ID
JOIN ORG organization ON organization.ID = demp.ORG_ID AND 1=1
WHERE ID = $Id

View SQL column type codec

SELECT 
    dept.* EXCEPT ORG_ID
    employee.* EXCEPT DEPT_ID, 
    organization.* 
FROM (SELECT * FROM DEPARMENT t) dept
JOIN (SELECT ID, NAME, DEPT_ID, 
    (CASE WHEN COLUMN_X = 1 THEN
            'x1,x2'
             WHEN COLUMN_X = 2 THEN
            'x3,x4'
       END) AS SLICE /* {"Codec":{"Ref":"AsStrings"}, "DataType": "string"} */  
    FROM EMP t) employee ON dept.ID = employee.DEPT_ID
JOIN ORG organization ON organization.ID = demp.ORG_ID AND 1=1
WHERE ID = $Id

Supported conversion Codecs

- AsStrings: converts coma separated value into []string

Persisting routes/config to the local folder

Use -w=location switch

datly -N=dept -T=DEPT -w=my_project

Documentation

Index

• Variables
• func New(version string, args []string, logger io.Writer) (*standalone.Server, error)
• type Column
• type Columns
  • func (c Columns) ByAlias() map[string]*Column
  • func (c Columns) ByNs(ns string) map[string]*Column
  • func (c Columns) StarExpr(ns string) *Column
• type Connector
  • func (c *Connector) Init()
  • func (c *Connector) MatchConnector(name string) *view.Connector
  • func (c *Connector) New() *view.Connector
  • func (c *Connector) Registry() map[string]*view.Connector
• type Content
• type Generate
  • func (g *Generate) Namespace() string
• type Join
• type Joins
  • func (j *Joins) Index() map[string]*Join
• type Options
  • func (o *Options) DepURL(uri string) string
  • func (o *Options) Init()
  • func (c *Options) ResponseField() string
  • func (o *Options) RouterURI() string
  • func (o *Options) RouterURL() string
  • func (o *Options) SQLURL(name string) string
• type Table
  • func ParseSQLx(SQL string) (*Table, map[string]*TableParam, error)
• type TableMeta
• type TableParam

Variables

var TimeNow = time.Now

Functions

func New

func New(version string, args []string, logger io.Writer) (*standalone.Server, error)

Types

type Column

type Column struct {
	Ns       string
	Name     string
	Alias    string
	Except   []string
	DataType string
}

type Columns

type Columns []*Column

func (Columns) ByAlias

func (c Columns) ByAlias() map[string]*Column

func (Columns) ByNs

func (c Columns) ByNs(ns string) map[string]*Column

func (Columns) StarExpr

func (c Columns) StarExpr(ns string) *Column

type Connector

type Connector struct {
	Connects []string `short:"C" long:"conn" description:"name|driver|dsn" `
	DbName   string   `short:"V" long:"dbname" description:"db/connector name" `
	Driver   string   `short:"D" long:"driver" description:"driver" `
	DSN      string   `short:"A" long:"dsn" description:"DSN" `
	Secret   string   `short:"E" long:"secret" description:"database secret" `
}

func (*Connector) Init

func (c *Connector) Init()

func (*Connector) MatchConnector

func (c *Connector) MatchConnector(name string) *view.Connector

MatchConnector returns matcher or default connector

func (*Connector) New

func (c *Connector) New() *view.Connector

func (*Connector) Registry

func (c *Connector) Registry() map[string]*view.Connector

type Content

type Content struct {
	Output         string `short:"O" long:"output" description:"output style" choice:"c" choice:"b" `
	RedirectSizeKb int    `short:"M" long:"redirect" description:"redirectMinSize" `
	RedirectURL    string `short:"L" long:"redirectURL" description:"redirectURL" `
}

type Generate

type Generate struct {
	Name         string   `short:"N" long:"name" description:"view DbName/route URI" `
	Table        string   `short:"T" long:"table" description:"table" `
	SQLLocation  string   `short:"S" long:"sql" description:"SQL location" `
	SQLXLocation string   `short:"X" long:"sqlx" description:"SQLX (extension for relation) location" `
	Relations    []string `short:"R" long:"relation" description:"relation in form of viewName:tableName" `
}

func (*Generate) Namespace

func (g *Generate) Namespace() string

type Join

type Join struct {
	Key      string
	KeyAlias string
	OwnerKey string
	OwnerNs  string
	Owner    *Table
	TableMeta
	Field string

	ToOne bool
	Table *Table
}

type Joins

type Joins []*Join

func (*Joins) Index

func (j *Joins) Index() map[string]*Join

type Options

type Options struct {
	Port          int    `short:"p" long:"port" description:"port"  `
	RouteURL      string `short:"r" long:"mode" description:"route URL"  `
	DependencyURL string `short:"d" long:"deps" description:"dependencies URL" `
	ConfigURL     string `short:"c" long:"config" description:"configuration URL" `
	JWTVerifier   string `short:"j" long:"jwt" description:"PublicKeyPath|EncKey" `
	WriteLocation string `short:"w" long:"write" description:"dump all config files to specified location" `
	Generate
	Connector
	Content
	OpenApiURL string `short:"o" long:"openapi"`
	Version    bool   `short:"v" long:"version"  description:"build version" `
}

func (*Options) DepURL

func (o *Options) DepURL(uri string) string

func (*Options) Init

func (o *Options) Init()

func (*Options) ResponseField

func (c *Options) ResponseField() string

func (*Options) RouterURI

func (o *Options) RouterURI() string

func (*Options) RouterURL

func (o *Options) RouterURL() string

func (*Options) SQLURL

func (o *Options) SQLURL(name string) string

type Table

type Table struct {
	Ref         string
	StarExpr    bool
	Inner       Columns
	ColumnTypes map[string]string
	InnerAlias  string
	InnerSQL    string
	Deps        map[string]string
	Columns     Columns
	Name        string
	SQL         string
	Joins       Joins
	Alias       string
	TableMeta
	ViewMeta *ast.ViewMeta
}

func ParseSQLx

func ParseSQLx(SQL string) (*Table, map[string]*TableParam, error)

type TableMeta

type TableMeta struct {
	Connector string
	Cache     *view.Cache

	Parameter *view.Parameter
	Auth      string
	// contains filtered or unexported fields
}

type TableParam

type TableParam struct {
	Table *Table
	Param *view.Parameter
}