gendb

package
v8.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 6, 2022 License: Apache-2.0 Imports: 21 Imported by: 0

Documentation

Index

Constants

View Source
const AssetDebug = false

AssetDebug is true if the assets were built with the debug flag enabled.

Variables

This section is empty.

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 AssetDigest

func AssetDigest(name string) ([sha256.Size]byte, error)

AssetDigest returns the digest of the file with the given name. It returns an error if the asset could not be found or the digest 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, and 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 AssetString

func AssetString(name string) (string, error)

AssetString returns the asset contents as a string (instead of a []byte).

func Digests

func Digests() (map[string][sha256.Size]byte, error)

Digests returns a map of all known files and their checksums.

func GenerateDB

func GenerateDB(packageName, packagePath string, s *spec.Swagger, outputPath string) 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 MustAssetString

func MustAssetString(name string) string

MustAssetString is like AssetString 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              []resources.AWSDynamoDBTable_KeySchema            `json:"KeySchema,omitempty"`
	GlobalSecondaryIndexes []resources.AWSDynamoDBTable_GlobalSecondaryIndex `json:"GlobalSecondaryIndexes,omitempty"`
	AttributesDefinitions  []resources.AWSDynamoDBTable_AttributeDefinition  `json:"AttributeDefinitions,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

	// AllowBatchWrites determines whether a batch write method should be generated for the table.
	AllowBatchWrites bool

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

	// AllowSecondaryIndexScan determines whether methods should be generated that scan each of the secondary indexes.
	AllowSecondaryIndexScan []string

	// DynamoDB configuration.
	DynamoDB AWSDynamoDBTable

	// EnableTransactions determines which schemas this schema will be able to perform transactions with. It only needs to be set for one per pair.
	EnableTransactions []string

	// 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(schemaNames []string) error

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL