Project

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

DbSchema project store all schemas.

Constructors

Link copied to clipboard
@JvmOverloads
constructor(name: String, dbId: String = "MySql")

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val _children: List<Folder<*>>
Link copied to clipboard
val catalogNames: Set<String>
Link copied to clipboard
open override val children: List<TreeUnit>
Link copied to clipboard
open override var comment: String?
Link copied to clipboard
val commentNotNull: String
Link copied to clipboard
open override var commentTags: Map<String, String>
Link copied to clipboard
val dbId: String
Link copied to clipboard
var ddlPostScript: String?
Link copied to clipboard
var ddlPreScript: String?
Link copied to clipboard
val entities: Iterable<AbstractTable>
Link copied to clipboard
val entityCount: Int
Link copied to clipboard
var file: File?

Is the file where the project is stored (the model file).

Link copied to clipboard
Link copied to clipboard
val isElasticsearch: Boolean
Link copied to clipboard
var isFreshImported: Boolean
Link copied to clipboard
open override val isMarkedForDeletion: Boolean
Link copied to clipboard
var isNotationStrict: Boolean
Link copied to clipboard
var isSyncProject: Boolean
Link copied to clipboard
open override var isVirtual: Boolean
Link copied to clipboard
open var key: String
Link copied to clipboard
Link copied to clipboard
open override var mutatedAt: Long
Link copied to clipboard
open override var name: String
Link copied to clipboard
Link copied to clipboard
open override val parent: TreeUnit?
Link copied to clipboard
var priorName: String?
Link copied to clipboard
Link copied to clipboard
val statistics: String
Link copied to clipboard
open override val symbolicName: String
Link copied to clipboard
var syncFilter: String?
Link copied to clipboard
open var syncFolders: List<List<AbstractUnit>>
Link copied to clipboard
var syncInitScript: String?
Link copied to clipboard
val title: String
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
fun cloneLayout(layout: Layout): Layout

Duplicate a layout in a new diagram

Link copied to clipboard
open operator override fun compareTo(other: AbstractUnit): Int
Link copied to clipboard
@JvmOverloads
fun convert(targetDbms: String, inheritanceType: ERROR CLASS: Symbol not found for InheritanceConverter.InheritanceType = InheritanceConverter.InheritanceType.ConcreteTable): Project

Convert the Project to other Dbms

Link copied to clipboard
fun createLayout(name: String): Layout

Create a new diagram

Link copied to clipboard
fun createLayoutIncludeAllTables(name: String, createGroups: Boolean): Layout
fun createLayoutIncludeAllTables(name: String, createGroups: Boolean, recursive: Boolean): Layout

Create a Layout and attach all project tables to it. Used in Groovy Scripts.

Link copied to clipboard
fun createSchema(schema: Schema): Schema
@JvmOverloads
fun createSchema(name: String, catalogName: String? = null): Schema
Link copied to clipboard
fun findSimilarUnitsAsInSelection(preselect: Set<TreeUnit>): List<TreeUnit>
Link copied to clipboard
open override fun getByName(name: String): TreeUnit?
Link copied to clipboard
open override fun getDisplayName(diagram: Diagram): String
Link copied to clipboard
open override fun getIcon(): ERROR CLASS: Symbol not found for Icon
Link copied to clipboard
fun getLayout(name: String): Layout?
Link copied to clipboard
fun getNotation(): ERROR CLASS: Symbol not found for Notation
Link copied to clipboard
fun getOrCreateSchema(name: String): Schema
Link copied to clipboard
Link copied to clipboard
fun getSchema(catalogDotSchemaName: String): Schema?
fun getSchema(catalogName: String?, schemaName: String?): Schema?
Link copied to clipboard
fun getSchemaInUseCatalog(schemaName: String): Schema?
fun getSchemaUsingMetaDataCatalogAndSchemaName(metaDataCatalogName: String?, metaDataSchemaName: String?): Schema?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun hasEntities(): Boolean
Link copied to clipboard
fun hasFile(): Boolean
Link copied to clipboard
fun hasOperativeConnector(): Boolean
Link copied to clipboard
fun hasSchemesWithSameName(): Boolean
Link copied to clipboard
Link copied to clipboard
fun isDbVersionBelow(version: String): Boolean
Link copied to clipboard
fun isDbVersionHigherEqual(version: String): Boolean
Link copied to clipboard
open override fun markForDeletion()

Call this method to mark a unit (table, column) to be deleted. It can be called from any thread. The effective deletion is done by calling project.refresh() or schema.refresh() on JavaFX GUI thread.

Link copied to clipboard
fun matches(unit: AbstractUnit?): Boolean
Link copied to clipboard
open override fun ref(): String
Link copied to clipboard
open override fun refresh()

Deleting a table, column, etc can be done for any thread, by calling table.markForDeletion(). The effective delete is done by calling this method, on the JavaFX thread (in GUI mode). This ensures the correct rendering of the project structure.

Link copied to clipboard
fun rename(newName: String): Boolean
Link copied to clipboard
fun sameAs(unit: AbstractUnit): Boolean
open fun sameAs(unit: AbstractUnit, considerRenaming: Boolean): Boolean
Link copied to clipboard
open override fun setCommentTag(key: String, value: String?)
Link copied to clipboard
fun setDbVersion(dbVersion: String?)
Link copied to clipboard
fun setNotation(notation: ERROR CLASS: Symbol not found for Notation)
Link copied to clipboard
open override fun toString(): String