DbSchema/com.wisecoders.dbs.schema

Package-level declarations

Types

AbstractFunction

abstract class AbstractFunction(schema: Schema, name: String) : Sql

SQL with in and out parameters

AttributeContentType

enum AttributeContentType : Enum<AttributeContentType>

AttributeSpec

enum AttributeSpec : Enum<AttributeSpec>

CLIConnectorManager

object CLIConnectorManager : ConnectorManager

Column

class Column @JvmOverloads constructor(val entity: Entity, name: String, val parentColumn: Column? = null, var dataType: DataType = DbmsTypes.get(entity.getDbId()).getDataType(ValueType.INTEGER), var contentType: AttributeContentType = AttributeContentType.UNKNOWN, var spec: AttributeSpec = AttributeSpec.normal) : AbstractUnit, Attribute, DbUnit

A column into a table.

CommentTag

class CommentTag(val name: String, appliesTo: String?)

ConnectivityTip

enum ConnectivityTip : Enum<ConnectivityTip>

Connector

class Connector

The generic connection to the database, stores all parameters required to connect. The effective connection is called Envoy.

ConnectorGroup

class ConnectorGroup(name: String) : AbstractUnit

A group of connections

ConnectorManager

open class ConnectorManager

Constraint

class Constraint(table: Table, name: String) : AbstractUnit, DbUnit

A constraint into a table. Sample: check ( age > 14 ).

DataType

open class DataType @JvmOverloads constructor(dbId: String, name: String, var valueType: ValueType = ValueType.VARCHAR) : AbstractUnit

Data type : varchar2, integer, etc. The actual length, precision, decimal are stored by each column apart.

DataTypeFormat

enum DataTypeFormat : Enum<DataTypeFormat>

DataTypeUtil

object DataTypeUtil

Utility class for data types.

DbUnit

interface DbUnit : TreeUnit

Expose

class Expose : HashMap<String?, Any?>

Container for the parameters used to generate the HTML5 and PDF documentation.

ForeignKey

class ForeignKey @JvmOverloads constructor(name: String, sourceEntity: AbstractTable, val targetEntity: AbstractTable, addToImportedRelations: Boolean = true) : AbstractUnit, Relation, DbUnit

Class representing a Foreign Key between two tables.

ForeignKeyAction

enum ForeignKeyAction : Enum<ForeignKeyAction>

Action taken by the foreign key when a value from primary key table is deleted.

Function

class Function(schema: Schema, name: String) : AbstractFunction, DbUnit

Function in database.

FunctionParameter

class FunctionParameter(val name: String?, val javaDataType: Int, val dataTypeName: String?, val paramInOut: Int, val ordinalPosition: Int)

A parameter of a function

GeneratorPlan

class GeneratorPlan

A generator plan is a collection of generator tables, for which we are going to generate random data.

GeneratorTable

class GeneratorTable(val table: Table, showErrorsAsValues: Boolean)

A Generator table contains data related to generating data into a table.

GenericValueType

enum GenericValueType : Enum<GenericValueType>

GroovyMethod

annotation class GroovyMethod

Used to mark methods which are public via Groovy interface

Index

class Index @JvmOverloads constructor(table: AbstractTable, name: String, isVirtual: Boolean = false) : AbstractUnit, DbUnit

Represent an index on columns

IndexType

enum IndexType : Enum<IndexType>

Defines different kind of indexes. Can be also sorting keys, partition or clustering keys. It stores also information about the uniqueness.

Language

enum Language : Enum<Language>

Layout

class Layout(val project: Project, name: String) : Diagram, AbstractLayout

Is a diagram plus the Relational Data Browse, SQL editors, Query Builders.

MaterializedView

class MaterializedView(schema: Schema, name: String) : View

NameFinder

class NameFinder(schema: Schema)

Precision

enum Precision : Enum<Precision>

Data type precision, states if the data type request a length or precision, decimal, enumeration or none

Procedure

class Procedure(schema: Schema, name: String) : AbstractFunction, DbUnit

Procedure in the database

Project

open class Project @JvmOverloads constructor(name: String, val dbId: String = "MySql") : AbstractUnit

DbSchema project store all schemas.

ProjectType

enum ProjectType : Enum<ProjectType>

The project type.

PropertyAddOn

open class PropertyAddOn(val propertyAddOnFolder: PropertyAddOnFolder, name: String) : Sql

RelationCardinality

enum RelationCardinality : Enum<RelationCardinality>

RelationType

enum RelationType : Enum<RelationType>

Rule

class Rule(_schema: Schema, name: String, owningTable: Table? = null) : Trigger

Schema

class Schema(val project: Project, name: String, catalogName: String?) : AbstractUnit, DbUnit, SyncPrioritizable

A schema in the database.

SchemaMapping

class SchemaMapping

Script

class Script(val layout: Layout, name: String) : Sql, ToolUnit

Store a SQL script, shown in the SQL editor.

ScriptAddOn

open class ScriptAddOn(val scriptAddOnFolder: ScriptAddOnFolder, name: String) : Sql

Sequence

class Sequence(val _schema: Schema, name: String) : AbstractUnit, DbUnit

A sequence in database. Protected constructor. To get a new entity use the methods start Entity class.

Sql

abstract class Sql(name: String) : AbstractUnit, SyncPrioritizable

Abstract class storing SQL text.

Table

class Table(_schema: Schema, name: String) : AbstractTable, DbUnit

A database table.

TableDependency

class TableDependency @JvmOverloads constructor(tables: List<Table>, useInlineForeignKeys: Boolean, considerVirtualFks: Boolean = false)

Utility class will arrange tables in the creation order.

Trigger

open class Trigger(_schema: Schema, name: String, val owningTable: AbstractTable? = null) : Sql, DbUnit

Trigger in the database.

UserDataType

class UserDataType(val _schema: Schema, name: String) : DataType, Entity, DbUnit

User defined data type, extends the standard data type.

ValueType

enum ValueType : Enum<ValueType>

View

open class View(schema: Schema, name: String) : AbstractTable, DbUnit

Database view. The View columns are generated by running the view SQL against the database.

ViewDependency

class ViewDependency(views: List<View>)

VirtualForeignKeySuggestion

class VirtualForeignKeySuggestion @JvmOverloads constructor(query: String?, val foreignKey: ForeignKey, error: String? = null, var isSelected: Boolean)