gendb

Documentation

Index

• func Asset(name string) ([]byte, error)
• func AssetAndInfo(name string) ([]byte, os.FileInfo, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func GenerateDB(packageName string, s *spec.Swagger, serviceName string, paths *spec.Paths) error
• func MustAsset(name string) []byte
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• type AWSDynamoDBTable
• type CompositeAttribute
• type XDBConfig
  • func DecodeConfig(schemaName string, schema spec.Schema, swaggerSpec spec.Swagger) (*XDBConfig, error)
  • func (config XDBConfig) Validate() error

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetAndInfo

func AssetAndInfo(name string) ([]byte, os.FileInfo, error)

AssetAndInfo loads and returns the asset and asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func GenerateDB

func GenerateDB(packageName string, s *spec.Swagger, serviceName string, paths *spec.Paths) error

GenerateDB generates DB code for schemas annotated with the x-db extension.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

Types

type AWSDynamoDBTable

type AWSDynamoDBTable struct {
	KeySchema              []cloudformation.AWSDynamoDBTable_KeySchema            `json:"KeySchema,omitempty"`
	GlobalSecondaryIndexes []cloudformation.AWSDynamoDBTable_GlobalSecondaryIndex `json:"GlobalSecondaryIndexes,omitempty"`
}

AWSDynamoDBTable is a subset of clouformation.AWSDynamoDBTable. Currently supported fields: -.DynamoDB.KeySchema: configures primary key future/todo: - GlobalSecondaryIndexes - TableName (if you want something other than pascalized model name)

type CompositeAttribute

type CompositeAttribute struct {
	AttributeName string
	Properties    []string
	Separator     string
}

CompositeAttribute is an attribute that is composed of multiple properties in the object's schema.

type XDBConfig

type XDBConfig struct {
	// AllowOverwrites sets whether saving an object that already exists should fail.
	AllowOverwrites bool

	// CompositeAttributes encodes attributes that are composed of multiple properties in the schema.
	CompositeAttributes []CompositeAttribute

	// AllowPrimaryIndexScan determines whether methods should be generated that scan the primary index.
	AllowPrimaryIndexScan bool

	// DynamoDB configuration.
	DynamoDB AWSDynamoDBTable

	// SwaggerSpec, Schema and SchemaName that the config was contained within.
	SwaggerSpec spec.Swagger
	Schema      spec.Schema
	SchemaName  string
}

XDBConfig is the configuration that exists in swagger.yml for auto-generated database code.

func DecodeConfig

func DecodeConfig(schemaName string, schema spec.Schema, swaggerSpec spec.Swagger) (*XDBConfig, error)

DecodeConfig extracts a db configuration from the schema definition, if one exists.

func (XDBConfig) Validate

func (config XDBConfig) Validate() error

Validate checks that the user enter a valid x-db config.