DbSchema/com.wisecoders.dbs.dbms.sync.engine.nodes/SyncPair

SyncPair

open class SyncPair<U : AbstractUnit?, P : AbstractUnit?> : SyncDiff

A pair of two elements which are compared, and their parents. It can be two columns, foreign keys, constriants, indexes, etc. One of elements can be empty (is missing) which will result in a TableExistsDiff, ColumnExistsDiff, IndexExistsDiff, etc. The parents ( which is in most cases the schema ) is required to be able to handle the element missing differences.

Parameters

The class of the parent element ( Schema for Tables, Table for Columns, Indexes, Constraints...)

Inheritors

EditorSyncRoot

Constructors

SyncPair

constructor(left: U?, mapping: SchemaMapping, right: U)

Can synchronize using a specific schema mapping. Used in :

constructor(left: U, right: U)

Used in:

constructor(leftParent: P, left: U, rightParent: P, right: U, descendIntoChildren: Boolean, mapping: SchemaMapping?)

Used in :

Types

Companion

object Companion

Properties

action

open override var action: SyncAction

childrenPairs

val childrenPairs: List<SyncPair<*, *>>

dependency

var dependency: TableDependency?

val diffCount: Int

val left: U?

val leftParent: P?

var mapping: SchemaMapping?

nodeDiff

open override val nodeDiff: AbstractDiff<*, *>?

parent

val parent: SyncPair<*, *>?

right

val right: U?

rightParent

val rightParent: P?

unit

val unit: U

Functions

actionWillDrop

fun actionWillDrop(action: SyncAction, into: SyncSide, onlyTablesColumns: Boolean): Int

Get the count of dropped items if this action is applied.

canSkipInDisplayAndShowChildrenDiffs

fun canSkipInDisplayAndShowChildrenDiffs(): Boolean

commitIntoDatabase

fun commitIntoDatabase(envoy: ERROR CLASS: Symbol not found for Envoy, into: SyncSide, onlyAction: SyncAction?)

fun commitIntoDatabase(connector: Connector?, into: SyncSide, onlyAction: SyncAction?)

Apply the selected actions in to the database. This requires to do first syncPair.setAction(SyncSide.toRight)

generateCommitScript

fun generateCommitScript(dbId: String, onlyAction: SyncAction?, into: SyncSide): AlterScript

Generate the commit script

fun generateCommitScript(dbId: String, onlyAction: SyncAction?, into: SyncSide, includeForeignKeysInCreateTable: Boolean): AlterScript

getDifferences

fun getDifferences(): List<AbstractDiff<*, *>>

Get a list of differences for this node. A node can be a pair of tables, or columns, and differences can be rename, exists diff, data type diff, mandatory diff, etc.

getParent

fun getParent(side: SyncSide): P?

getUnit

open override fun getUnit(side: SyncSide): U?

hasDifferences

fun hasDifferences(): Boolean

hasNodesWithAction

fun hasNodesWithAction(action: SyncAction?): Boolean

matches

open override fun matches(filter: SyncDiffFilter): Boolean

mergeInto

@JvmOverloads

fun mergeInto(into: SyncSide, onlyAction: SyncAction?, layoutPane: ERROR CLASS: Symbol not found for GenericLayoutPane?? = null)

Merge differences into the local model

removeChildrenWithAction

fun removeChildrenWithAction(action: SyncAction?)

removeIf

fun removeIf(filter: ERROR CLASS: Symbol not found for SyncFilter)

Filter all tree using a given filter. The rejected differences will be removed

setAction

open override fun setAction(action: SyncAction, recursive: Boolean)

Set an action for this and all sub-nodes. This is similar with the Synchronization dialog, like clicking an action for each element. SyncAction.toLeft would mean to modify the model, toRight to modify the database.

setAlwaysIncludeFks

fun setAlwaysIncludeFks(alwaysIncludeFks: Boolean)

synchronize

fun synchronize()

toSql

fun toSql(dbId: String, onlyAction: SyncAction?, into: SyncSide, writer: PrintWriter)

Generate the script for a Synchronization operation.

toString

open override fun toString(): String

fun toString(level: Int): String