DbSchema/com.wisecoders.dbs.schema/Connector

Connector

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

Constructors

Connector

constructor(dbId: String, name: String)

Connector always belongs to a project

constructor(alias: String, dbId: String, driverJarClassName: String?, driverJarFileName: String?, jdbcUrlPattern: ERROR CLASS: Symbol not found for JdbcUrlPattern??, host: String?, port: Int, dbInstance: String?, userName: String?, readOnly: Boolean)

Connector with parameters

Types

Companion

object Companion

Environment

enum Environment : Enum<Connector.Environment>

JCraftUserInfo

inner class JCraftUserInfo : UserInfo, UIKeyboardInteractive

Properties

activeCatalogName

var activeCatalogName: String?

activeCliSchema

val activeCliSchema: Schema?

cliProject

val cliProject: Project

connectionProperties

var connectionProperties: String?

customUrl

var customUrl: String?

dbId

val dbId: String

driverJarClassName

var driverJarClassName: String?

driverJarFileName

var driverJarFileName: String?

driverUrl

var driverUrl: ERROR CLASS: Symbol not found for JdbcUrlPattern??

environment

var environment: Connector.Environment

host

var host: String?

instance

var instance: String?

isLocalhost

val isLocalhost: Boolean

isLocalhostAndDefaultPort

val isLocalhostAndDefaultPort: Boolean

isMarkedForDeletion

var isMarkedForDeletion: Boolean

isMongo

val isMongo: Boolean

isProcessing

val isProcessing: Boolean

isReadOnly

var isReadOnly: Boolean

isRememberPassword

var isRememberPassword: Boolean

isSshEnable

var isSshEnable: Boolean

isSshUseKey

var isSshUseKey: Boolean

isVisibleInMenu

var isVisibleInMenu: Boolean

mapping

val mapping: SchemaMapping

name

var name: String

parameter

var parameter: String?

parameter2

var parameter2: String?

parameter3

var parameter3: String?

parameter4

var parameter4: String?

parameter5

var parameter5: String?

password

var password: String?

port

var port: Int

properties

val properties: Properties

sshHost

var sshHost: String?

sshLocalPort

val sshLocalPort: Int

sshPassphrase

var sshPassphrase: String?

sshPassword

var sshPassword: String?

sshPort

var sshPort: Int

sshPrivateKeyFile

var sshPrivateKeyFile: String?

sshUser

var sshUser: String?

statistics

val statistics: String

statusString

val statusString: String

timeZone

var timeZone: String?

url

val url: String?

urlTemplateName

var urlTemplateName: String?

userName

var userName: String?

Functions

addSqlEvent

@Synchronized

fun addSqlEvent(event: ERROR CLASS: Symbol not found for SqlEvent)

closeAllEnvoysAndSsh

fun closeAllEnvoysAndSsh()

delaySchemaHasMutated

fun delaySchemaHasMutated()

generateData

fun generateData(generatorTable: GeneratorTable)

getHTMLMessageAndAdvice

fun getHTMLMessageAndAdvice(ex: Throwable?, title: String?, message: String?, tip: ConnectivityTip?): String

getPlainMessageAndAdvice

fun getPlainMessageAndAdvice(ex: Throwable): String

hasActiveEnvoys

fun hasActiveEnvoys(): Boolean

importSchema

fun importSchema(project: Project, catalogDotSchemaName: String): Schema

Reverse engineer given schema from database. Schema name can be simply the schmema name or catalog dot schema name if multiple catalogs (databases) are available. METHOD EXPOSED FOR GROOVY.

importSchemes

fun importSchemes(project: Project, vararg catalogDotSchemaName: String?): List<Schema>

fun importSchemes(project: Project, selectionCallback: Callback<TreeSelection?, Void?>?, vararg catalogDotSchemaName: String): List<Schema>

Reverse engineer given schema from database. Each entry can be a catalog.schema if there are multiple databases(catalogs) available METHOD EXPOSED FOR GROOVY.

learnDbmsIfRequired

fun learnDbmsIfRequired()

learnDbmsTemplate

fun learnDbmsTemplate()

loadDriverForSampleProject

fun loadDriverForSampleProject()

loadFromHistory

fun loadFromHistory(alias: String)

markForDeletion

fun markForDeletion()

needsEdit

fun needsEdit(): Boolean