KSLCore/ksl.utilities.io.dbutil/DatabaseIOIfc

DatabaseIOIfc

interface DatabaseIOIfc

An interface that defines basic I/O capabilities for a database.

Inheritors

DatabaseIfc

KSLDatabase

Properties

defaultSchemaName

abstract var defaultSchemaName: String?

Sets the name of the default schema

label

abstract var label: String

identifying string representing the database. This has no relation to the name of the database on disk or in the dbms. The sole purpose is for labeling of output

outputDirectory

abstract var outputDirectory: OutputDirectory

schemaNames

abstract val schemaNames: List<String>

userDefinedTables

abstract val userDefinedTables: Map<String?, List<String>>

The returned map may have a null key because not all databases support the schema concept. There can be table names associated with null as the key.

views

abstract val views: Map<String?, List<String>>

The returned map may have a null key because not all databases support the schema concept. There can be view names associated with null as the key.

Functions

exportAllTablesAsCSV

abstract fun exportAllTablesAsCSV(schemaName: String? = defaultSchemaName, pathToOutPutDirectory: Path = outputDirectory.csvDir, header: Boolean = true)

Writes all tables as separate comma separated value files into the supplied directory. The files are written to text files using the same name as the tables in the database

exportAllTablesAsInsertQueries

abstract fun exportAllTablesAsInsertQueries(schemaName: String? = defaultSchemaName, out: PrintWriter = outputDirectory.createPrintWriter("${label}_TableInserts.sql"))

Writes all table data as insert queries to the PrintWriter

exportAllViewsAsCSV

abstract fun exportAllViewsAsCSV(schemaName: String? = defaultSchemaName, pathToOutPutDirectory: Path = outputDirectory.csvDir, header: Boolean = true)

Writes all tables as separate comma separated value files into the supplied directory. The files are written to text files using the same name as the tables in the database

exportInsertQueries

abstract fun exportInsertQueries(tableName: String, schemaName: String? = defaultSchemaName, out: PrintWriter = outputDirectory.createPrintWriter("${label}_${tableName}_Inserts.sql"))

Writes the insert queries associated with the supplied table to the PrintWriter

exportTableAsCSV

abstract fun exportTableAsCSV(tableName: String, schemaName: String? = defaultSchemaName, out: PrintWriter = outputDirectory.createPrintWriter("${tableName}.csv"), header: Boolean = true)

Writes the table as comma separated values

exportToExcel

abstract fun exportToExcel(schemaName: String? = defaultSchemaName, wbName: String = label, wbDirectory: Path = outputDirectory.excelDir)

Writes each table in the schema to an Excel workbook with each table being placed in a new sheet with the sheet name equal to the name of the table. The column names for each table are written as the first row of each sheet.

abstract fun exportToExcel(tableNames: List<String>, schemaName: String? = defaultSchemaName, wbName: String = label.substringBeforeLast("."), wbDirectory: Path = outputDirectory.excelDir)

Writes each table in the list to an Excel workbook with each table being placed in a new sheet with the sheet name equal to the name of the table. The column names for each table are written as the first row of each sheet.

importWorkbookToSchema

abstract fun importWorkbookToSchema(pathToWorkbook: Path, tableNames: List<String>, schemaName: String? = defaultSchemaName, skipFirstRow: Boolean = true)

Opens the workbook for reading only and writes the sheets of the workbook into database tables. The list of names is the names of the sheets in the workbook and the names of the tables that need to be written. They are in the order that is required for entering data so that no integrity constraints are violated. The underlying workbook is closed after the operation.

printAllTablesAsInsertQueries

abstract fun printAllTablesAsInsertQueries(schemaName: String? = defaultSchemaName)

Prints all table data as insert queries to the console

printAllTablesAsMarkdown

abstract fun printAllTablesAsMarkdown(schemaName: String? = defaultSchemaName)

Prints all tables as text to the console

printAllTablesAsText

abstract fun printAllTablesAsText(schemaName: String? = defaultSchemaName)

Prints all tables as text to the console

printInsertQueries

abstract fun printInsertQueries(tableName: String, schemaName: String? = defaultSchemaName)

Prints the insert queries associated with the supplied table to the console

printTableAsCSV

abstract fun printTableAsCSV(tableName: String, schemaName: String? = defaultSchemaName, header: Boolean = true)

Prints the table as comma separated values to the console

printTableAsMarkdown

abstract fun printTableAsMarkdown(tableName: String, schemaName: String? = defaultSchemaName)

Prints the table as prettified text to the console

printTableAsText

abstract fun printTableAsText(tableName: String, schemaName: String? = defaultSchemaName)

Prints the table as prettified text to the console

writeAllTablesAsMarkdown

abstract fun writeAllTablesAsMarkdown(schemaName: String? = defaultSchemaName, out: PrintWriter = outputDirectory.createPrintWriter("${label}_Tables.md"))

Writes all tables as text

writeAllTablesAsText

abstract fun writeAllTablesAsText(schemaName: String? = defaultSchemaName, out: PrintWriter = outputDirectory.createPrintWriter("${label}_Tables.txt"))

Writes all tables as text

writeAllViewsAsMarkdown

abstract fun writeAllViewsAsMarkdown(schemaName: String? = defaultSchemaName, out: PrintWriter = outputDirectory.createPrintWriter("${label}_Views.md"))

Writes all tables as text

writeTableAsMarkdown

abstract fun writeTableAsMarkdown(tableName: String, schemaName: String? = defaultSchemaName, out: PrintWriter = outputDirectory.createPrintWriter("${label}_${tableName}.md"))

Writes the table as prettified text.

writeTableAsText

abstract fun writeTableAsText(tableName: String, schemaName: String? = defaultSchemaName, out: PrintWriter = outputDirectory.createPrintWriter("${label}_${tableName}.txt"))

Writes the table as prettified text.