# API
# Functions
- allData(db) ⇒
Object Object returned from this function will be merged with template variables and available in every template file. This function is executed for each generated file.
- dbData(db) ⇒
Object Object returned from this function will be merged with template variables and available in templates located in db directory. This function is executed for each generated file resulted from templates in db directory.
- schemaData(schema) ⇒
Object Object returned from this function will be merged with template variables and available in templates located in schema directory. This function is executed for each generated file resulted from templates in schema directory.
- tableData(table) ⇒
Object Object returned from this function will be merged with template variables and available in templates located in table directory. This function is executed for each generated file resulted from templates in table directory.
Object
Object returned from this function will be merged with template variables and available in every template file.
This function is executed for each generated file.
Kind: global function
Returns: Object - - Object to be merged with template variables.
| Param | Type | Description |
|---|---|---|
| db | pgStructure.db | pg-structure db object (opens new window). |
# dbData(db) ⇒ Object
Object returned from this function will be merged with template variables and available in templates located in db directory. This function is executed for each generated file resulted from templates in db directory.
Kind: global function
Returns: Object - - Object to be merged with template variables.
| Param | Type | Description |
|---|---|---|
| db | pgStructure.db | pg-structure db object (opens new window). |
# schemaData(schema) ⇒ Object
Object returned from this function will be merged with template variables and available in templates located in schema directory. This function is executed for each generated file resulted from templates in schema directory.
Kind: global function
Returns: Object - - Object to be merged with template variables.
| Param | Type | Description |
|---|---|---|
| schema | pgStructure.schema | pg-structure schema object (opens new window). |
# tableData(table) ⇒ Object
Object returned from this function will be merged with template variables and available in templates located in table directory. This function is executed for each generated file resulted from templates in table directory.
Kind: global function
Returns: Object - - Object to be merged with template variables.
| Param | Type | Description |
|---|---|---|
| table | pgStructure.table | pg-structure table object (opens new window). |