er

Documentation

Index

• type ERCol
• type ERDatabase
  • func DatabaseERFromDB(database *sqlx.Database, dialect builder.Dialect) *ERDatabase
• type EREnum
• type ERKey
• type ERTable

Examples

• DatabaseERFromDB

Types

type ERCol

type ERCol struct {
	Name     string            `json:"name"`
	DataType string            `json:"dataType"`
	Enum     map[string]EREnum `json:"enum"`
	Summary  string            `json:"summary"`
	Desc     string            `json:"desc"`
	Rel      []string          `json:"rel"`
}

type ERDatabase

type ERDatabase struct {
	Name   string              `json:"name"`
	Tables map[string]*ERTable `json:"tables"`
}

func DatabaseERFromDB

func DatabaseERFromDB(database *sqlx.Database, dialect builder.Dialect) *ERDatabase

Example

package main

import (
	"encoding/json"

	"github.com/go-courier/sqlx/v2/er"
	"github.com/go-courier/sqlx/v2/generator/__examples__/database"
	"github.com/go-courier/sqlx/v2/postgresqlconnector"
)

func main() {
	ers := er.DatabaseERFromDB(database.DBTest, &postgresqlconnector.PostgreSQLConnector{})
	_, _ = json.MarshalIndent(ers, "", "  ")
}

type EREnum

type EREnum struct {
	Value int    `json:"value"`
	Name  string `json:"name"`
	Label string `json:"label"`
}

type ERKey

type ERKey struct {
	Name      string   `json:"name"`
	Method    string   `json:"method"`
	IsUnique  bool     `json:"isUnique"`
	IsPrimary bool     `json:"isPrimary"`
	Cols      []string `json:"cols"`
}

type ERTable

type ERTable struct {
	Name    string            `json:"name"`
	Summary string            `json:"summary"`
	Desc    string            `json:"desc"`
	Cols    map[string]*ERCol `json:"cols"`
	Keys    map[string]*ERKey `json:"keys"`
}