BetterMetadata/dev.warrengates.bettermetadata

Package dev.warrengates.bettermetadata

Types

class Attribute(rs: ResultSet)

Wrapper for results of getAttributes method and represents an attribute of a UserDefinedType.

AttributeNullable

enum AttributeNullable : Enum<AttributeNullable> , IntegerEnum

Indicates whether NULL is allowed

BestRowColumnType

enum BestRowColumnType : Enum<BestRowColumnType> , IntegerEnum

Indicates whether best row column is a pseudo column like an Oracle ROWID

BestRowIdentifier

class BestRowIdentifier(rs: ResultSet)

Wrapper for results of getBestRowIdentifier method and represents the optimal set of columns that uniquely identify a Table's row

BestRowIdentifierScope

enum BestRowIdentifierScope : Enum<BestRowIdentifierScope> , IntegerEnum

Best row identifier scope

ClientInfoProperties

class ClientInfoProperties(rs: ResultSet)

Wrapper for results of getClientInfoProperties method and represents a list of the client info properties supported by the current driver

class Column(metadata: DatabaseMetaData, rs: ResultSet)

Wrapper for results of getColumns method and represents a Table column

enum ColumnNullable : Enum<ColumnNullable> , IntegerEnum

Column nullable

ColumnPrivilege

class ColumnPrivilege(rs: ResultSet)

Wrapper for results of getColumnPrivileges method. Used from Column.getColumnPrivileges

class Database @JvmOverloads constructor( metadata: DatabaseMetaData, val defaultCatalog: String? = null, val defaultSchema: String? = null)

Provides a wrapper around DatabaseMetaData.

ForeignKeyDeleteRule

enum ForeignKeyDeleteRule : Enum<ForeignKeyDeleteRule> , IntegerEnum

Foreign key delete rule

ForeignKeyInitialDeferrability

enum ForeignKeyInitialDeferrability : Enum<ForeignKeyInitialDeferrability> , IntegerEnum

Foreign key initial deferrability

ForeignKeyUpdateRule

enum ForeignKeyUpdateRule : Enum<ForeignKeyUpdateRule> , IntegerEnum

Foreign key update rule

class Function(metadata: DatabaseMetaData, rs: ResultSet)

Wrapper for results of getFunctions method and represents user and system functions

class FunctionColumn(rs: ResultSet)

Wrapper for results of getFunctionColumns method and represents a column of Function

FunctionColumnNullable

enum FunctionColumnNullable : Enum<FunctionColumnNullable> , IntegerEnum

Function column nullable

FunctionColumnType

enum FunctionColumnType : Enum<FunctionColumnType> , IntegerEnum

Function column type

FunctionReturnType

enum FunctionReturnType : Enum<FunctionReturnType> , IntegerEnum

Function return type

class Index(rs: ResultSet)

Wrapper for the results of the getIndexInfo method and represents a Table's indices and statistics. Returned from Table.getIndexes

enum IndexSort : Enum<IndexSort> , StringEnum

Index sort

enum IndexType : Enum<IndexType> , IntegerEnum

Index type

interface IntegerEnum

Integer enum, convenience interface for converting integer values to enums

IsAutoIncrement

enum IsAutoIncrement : Enum<IsAutoIncrement> , StringEnum

Is auto increment, values taken from returned strings

IsGeneratedColumn

enum IsGeneratedColumn : Enum<IsGeneratedColumn> , StringEnum

Is generated column, values taken from returned strings

enum IsGrantable : Enum<IsGrantable> , StringEnum

Is grantable, values taken from returned strings

enum IsNullable : Enum<IsNullable> , StringEnum

Is nullable, values taken from returned strings

class Key( val primaryKeyName: String?, val foreignKeyName: String?, val updateRule: ForeignKeyUpdateRule, val deleteRule: ForeignKeyDeleteRule, val deferrability: ForeignKeyInitialDeferrability, val keyColumns: List<KeyColumn>)

Key

class KeyColumn( val primaryKeyColumn: Column, val foreignKeyColumn: Column, val sequenceNumber: Int)

Key column

typealias MetadataInt = Int?

Various integer columns (such as DECIMAL_DIGTS) returned from DatabaseMetaData functions indicate that null is returned when the value is not applicable. Since ResultSet.getInt returns 0 for null values, you'll never actually get null returned. If you'd prefer to have nulls returned when null exists in the ResultSet, use the below code. It uses a nullable Int (kotlin) or Integer (java) and sets it to null appropriately.

If you'd rather get 0 values instead of nulls, comment out the code immediately below and use the 'Non-nullable int' code at the bottom

Note that at this point not all possible values are using this type alias

class PrimaryKey(val name: String?, val primaryKeyColumns: List<PrimaryKeyColumn>)

Wrapper for results of getPrimaryKeys. It has been refactored to provide of Column object rather than the flattened view provided by the getPrimaryKeys method.

PrimaryKeyColumn

class PrimaryKeyColumn(val column: Column, val sequenceNumber: Int)

Holds a Column and its sequence number for use in PrimaryKey

class Procedure(metadata: DatabaseMetaData, rs: ResultSet)

Wrapper for results of getProcedures method and represents a stored procedure

ProcedureColumn

class ProcedureColumn(rs: ResultSet)

Wrapper for results of getProcedureColumns

ProcedureColumnNullable

enum ProcedureColumnNullable : Enum<ProcedureColumnNullable> , IntegerEnum

Procedure column nullable

ProcedureColumnType

enum ProcedureColumnType : Enum<ProcedureColumnType> , IntegerEnum

Procedure column type

ProcedureReturnType

enum ProcedureReturnType : Enum<ProcedureReturnType> , IntegerEnum

Procedure return type

class PseudoColumn(rs: ResultSet)

Wrapper for results of getPseudoColumns

ResultSetConcurrency

enum ResultSetConcurrency : Enum<ResultSetConcurrency> , IntegerEnum

Result set concurrency

ResultSetHoldability

enum ResultSetHoldability : Enum<ResultSetHoldability> , IntegerEnum

Result set holdability

enum ResultSetType : Enum<ResultSetType> , IntegerEnum

Result set type

class Schema(rs: ResultSet)

Wrapper for results of getSchemas

enum SQLStateType : Enum<SQLStateType> , IntegerEnum

SQL state type

interface StringEnum

String enum, convenience interface for converting string values to enums

class SuperType(rs: ResultSet)

Wrapper for results of getSuperTypes

class Table(metadata: DatabaseMetaData, rs: ResultSet)

Wrapper for the results of getTables

class TablePrivilege(rs: ResultSet)

Wrapper for results of getTablePrivileges

TransactionIsolation

enum TransactionIsolation : Enum<TransactionIsolation> , IntegerEnum

Transaction isolation

class TypeInfo(rs: ResultSet)

Wrapper for results of getTypeInfo

enum TypeNullable : Enum<TypeNullable> , IntegerEnum

Type nullable

enum TypeSearchable : Enum<TypeSearchable> , IntegerEnum

Type searchable

UserDefinedType

class UserDefinedType(metaData: DatabaseMetaData, rs: ResultSet)

Wrapper for results of getUDTs

class VersionColumn(rs: ResultSet)

Wrapper for results of getVersionColumns

VersionColumnType

enum VersionColumnType : Enum<VersionColumnType> , IntegerEnum

Version column type

Functions

inline fun <T : Enum<T>, IntegerEnum> valueOf(value: Int): T

Gets enum of type T where the enums' value matches value. The enum must implement IntegerEnum

inline fun <T : Enum<T>, StringEnum> valueOf(value: String): T

Gets enum of type T where the enums' value matches value. The enum must implement StringEnum