doobie.free

databasemetadata

object databasemetadata

Algebra and free monad for primitive operations over a java.sql.DatabaseMetaData. This is a low-level API that exposes lifecycle-managed JDBC objects directly and is intended mainly for library developers. End users will prefer a safer, higher-level API such as that provided in the doobie.hi package.

DatabaseMetaDataIO is a free monad that must be run via an interpreter, most commonly via natural transformation of its underlying algebra DatabaseMetaDataOp to another monad via Free#foldMap.

The library provides a natural transformation to Kleisli[M, DatabaseMetaData, A] for any exception-trapping (Catchable) and effect-capturing (Capture) monad M. Such evidence is provided for Task, IO, and stdlib Future; and transK[M] is provided as syntax.

// An action to run
val a: DatabaseMetaDataIO[Foo] = ...

// A JDBC object
val s: DatabaseMetaData = ...

// Unfolding into a Task
val ta: Task[A] = a.transK[Task].run(s)
Source
databasemetadata.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. databasemetadata
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type DatabaseMetaDataIO[A] = Free[DatabaseMetaDataOp, A]

    Free monad over a free functor of DatabaseMetaDataOp; abstractly, a computation that consumes a java.sql.DatabaseMetaData and produces a value of type A.

  2. implicit class DatabaseMetaDataIOOps[A] extends AnyRef

    Syntax for DatabaseMetaDataIO.

  3. sealed trait DatabaseMetaDataOp[A] extends AnyRef

    Sum type of primitive operations over a java.sql.DatabaseMetaData.

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. implicit val CaptureDatabaseMetaDataIO: Capture[DatabaseMetaDataIO]

    Capture instance for DatabaseMetaDataIO.

  7. implicit val CatchableDatabaseMetaDataIO: Catchable[DatabaseMetaDataIO]

    Catchable instance for DatabaseMetaDataIO.

  8. object DatabaseMetaDataOp

    Module of constructors for DatabaseMetaDataOp.

  9. val allProceduresAreCallable: DatabaseMetaDataIO[Boolean]

  10. val allTablesAreSelectable: DatabaseMetaDataIO[Boolean]

  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  12. def attempt[A](a: DatabaseMetaDataIO[A]): DatabaseMetaDataIO[\/[Throwable, A]]

    Lift a DatabaseMetaDataIO[A] into an exception-capturing DatabaseMetaDataIO[Throwable \/ A].

  13. val autoCommitFailureClosesAllResultSets: DatabaseMetaDataIO[Boolean]

  14. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  15. val dataDefinitionCausesTransactionCommit: DatabaseMetaDataIO[Boolean]

  16. val dataDefinitionIgnoredInTransactions: DatabaseMetaDataIO[Boolean]

  17. def delay[A](a: ⇒ A): DatabaseMetaDataIO[A]

    Non-strict unit for capturing effects.

  18. def deletesAreDetected(a: Int): DatabaseMetaDataIO[Boolean]

  19. val doesMaxRowSizeIncludeBlobs: DatabaseMetaDataIO[Boolean]

  20. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  21. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  22. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. val generatedKeyAlwaysReturned: DatabaseMetaDataIO[Boolean]

  24. def getAttributes(a: String, b: String, c: String, d: String): DatabaseMetaDataIO[ResultSet]

  25. def getBestRowIdentifier(a: String, b: String, c: String, d: Int, e: Boolean): DatabaseMetaDataIO[ResultSet]

  26. val getCatalogSeparator: DatabaseMetaDataIO[String]

  27. val getCatalogTerm: DatabaseMetaDataIO[String]

  28. val getCatalogs: DatabaseMetaDataIO[ResultSet]

  29. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  30. val getClientInfoProperties: DatabaseMetaDataIO[ResultSet]

  31. def getColumnPrivileges(a: String, b: String, c: String, d: String): DatabaseMetaDataIO[ResultSet]

  32. def getColumns(a: String, b: String, c: String, d: String): DatabaseMetaDataIO[ResultSet]

  33. val getConnection: DatabaseMetaDataIO[Connection]

  34. def getCrossReference(a: String, b: String, c: String, d: String, e: String, f: String): DatabaseMetaDataIO[ResultSet]

  35. val getDatabaseMajorVersion: DatabaseMetaDataIO[Int]

  36. val getDatabaseMinorVersion: DatabaseMetaDataIO[Int]

  37. val getDatabaseProductName: DatabaseMetaDataIO[String]

  38. val getDatabaseProductVersion: DatabaseMetaDataIO[String]

  39. val getDefaultTransactionIsolation: DatabaseMetaDataIO[Int]

  40. val getDriverMajorVersion: DatabaseMetaDataIO[Int]

  41. val getDriverMinorVersion: DatabaseMetaDataIO[Int]

  42. val getDriverName: DatabaseMetaDataIO[String]

  43. val getDriverVersion: DatabaseMetaDataIO[String]

  44. def getExportedKeys(a: String, b: String, c: String): DatabaseMetaDataIO[ResultSet]

  45. val getExtraNameCharacters: DatabaseMetaDataIO[String]

  46. def getFunctionColumns(a: String, b: String, c: String, d: String): DatabaseMetaDataIO[ResultSet]

  47. def getFunctions(a: String, b: String, c: String): DatabaseMetaDataIO[ResultSet]

  48. val getIdentifierQuoteString: DatabaseMetaDataIO[String]

  49. def getImportedKeys(a: String, b: String, c: String): DatabaseMetaDataIO[ResultSet]

  50. def getIndexInfo(a: String, b: String, c: String, d: Boolean, e: Boolean): DatabaseMetaDataIO[ResultSet]

  51. val getJDBCMajorVersion: DatabaseMetaDataIO[Int]

  52. val getJDBCMinorVersion: DatabaseMetaDataIO[Int]

  53. val getMaxBinaryLiteralLength: DatabaseMetaDataIO[Int]

  54. val getMaxCatalogNameLength: DatabaseMetaDataIO[Int]

  55. val getMaxCharLiteralLength: DatabaseMetaDataIO[Int]

  56. val getMaxColumnNameLength: DatabaseMetaDataIO[Int]

  57. val getMaxColumnsInGroupBy: DatabaseMetaDataIO[Int]

  58. val getMaxColumnsInIndex: DatabaseMetaDataIO[Int]

  59. val getMaxColumnsInOrderBy: DatabaseMetaDataIO[Int]

  60. val getMaxColumnsInSelect: DatabaseMetaDataIO[Int]

  61. val getMaxColumnsInTable: DatabaseMetaDataIO[Int]

  62. val getMaxConnections: DatabaseMetaDataIO[Int]

  63. val getMaxCursorNameLength: DatabaseMetaDataIO[Int]

  64. val getMaxIndexLength: DatabaseMetaDataIO[Int]

  65. val getMaxProcedureNameLength: DatabaseMetaDataIO[Int]

  66. val getMaxRowSize: DatabaseMetaDataIO[Int]

  67. val getMaxSchemaNameLength: DatabaseMetaDataIO[Int]

  68. val getMaxStatementLength: DatabaseMetaDataIO[Int]

  69. val getMaxStatements: DatabaseMetaDataIO[Int]

  70. val getMaxTableNameLength: DatabaseMetaDataIO[Int]

  71. val getMaxTablesInSelect: DatabaseMetaDataIO[Int]

  72. val getMaxUserNameLength: DatabaseMetaDataIO[Int]

  73. val getNumericFunctions: DatabaseMetaDataIO[String]

  74. def getPrimaryKeys(a: String, b: String, c: String): DatabaseMetaDataIO[ResultSet]

  75. def getProcedureColumns(a: String, b: String, c: String, d: String): DatabaseMetaDataIO[ResultSet]

  76. val getProcedureTerm: DatabaseMetaDataIO[String]

  77. def getProcedures(a: String, b: String, c: String): DatabaseMetaDataIO[ResultSet]

  78. def getPseudoColumns(a: String, b: String, c: String, d: String): DatabaseMetaDataIO[ResultSet]

  79. val getResultSetHoldability: DatabaseMetaDataIO[Int]

  80. val getRowIdLifetime: DatabaseMetaDataIO[RowIdLifetime]

  81. val getSQLKeywords: DatabaseMetaDataIO[String]

  82. val getSQLStateType: DatabaseMetaDataIO[Int]

  83. val getSchemaTerm: DatabaseMetaDataIO[String]

  84. def getSchemas(a: String, b: String): DatabaseMetaDataIO[ResultSet]

  85. val getSchemas: DatabaseMetaDataIO[ResultSet]

  86. val getSearchStringEscape: DatabaseMetaDataIO[String]

  87. val getStringFunctions: DatabaseMetaDataIO[String]

  88. def getSuperTables(a: String, b: String, c: String): DatabaseMetaDataIO[ResultSet]

  89. def getSuperTypes(a: String, b: String, c: String): DatabaseMetaDataIO[ResultSet]

  90. val getSystemFunctions: DatabaseMetaDataIO[String]

  91. def getTablePrivileges(a: String, b: String, c: String): DatabaseMetaDataIO[ResultSet]

  92. val getTableTypes: DatabaseMetaDataIO[ResultSet]

  93. def getTables(a: String, b: String, c: String, d: Array[String]): DatabaseMetaDataIO[ResultSet]

  94. val getTimeDateFunctions: DatabaseMetaDataIO[String]

  95. val getTypeInfo: DatabaseMetaDataIO[ResultSet]

  96. def getUDTs(a: String, b: String, c: String, d: Array[Int]): DatabaseMetaDataIO[ResultSet]

  97. val getURL: DatabaseMetaDataIO[String]

  98. val getUserName: DatabaseMetaDataIO[String]

  99. def getVersionColumns(a: String, b: String, c: String): DatabaseMetaDataIO[ResultSet]

  100. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  101. def insertsAreDetected(a: Int): DatabaseMetaDataIO[Boolean]

  102. def interpK[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[DatabaseMetaDataOp, [γ]Kleisli[M, DatabaseMetaData, γ]]

    Natural transformation from DatabaseMetaDataOp to Kleisli for the given M, consuming a java.sql.DatabaseMetaData.

  103. val isCatalogAtStart: DatabaseMetaDataIO[Boolean]

  104. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  105. val isReadOnly: DatabaseMetaDataIO[Boolean]

  106. def isWrapperFor(a: Class[_]): DatabaseMetaDataIO[Boolean]

  107. def lift[Op[_], A, J](j: J, action: Free[Op, A])(implicit mod: Aux[Op, J]): DatabaseMetaDataIO[A]

    Lift a different type of program that has a default Kleisli interpreter.

  108. val locatorsUpdateCopy: DatabaseMetaDataIO[Boolean]

  109. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  110. final def notify(): Unit

    Definition Classes
    AnyRef
  111. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  112. val nullPlusNonNullIsNull: DatabaseMetaDataIO[Boolean]

  113. val nullsAreSortedAtEnd: DatabaseMetaDataIO[Boolean]

  114. val nullsAreSortedAtStart: DatabaseMetaDataIO[Boolean]

  115. val nullsAreSortedHigh: DatabaseMetaDataIO[Boolean]

  116. val nullsAreSortedLow: DatabaseMetaDataIO[Boolean]

  117. def othersDeletesAreVisible(a: Int): DatabaseMetaDataIO[Boolean]

  118. def othersInsertsAreVisible(a: Int): DatabaseMetaDataIO[Boolean]

  119. def othersUpdatesAreVisible(a: Int): DatabaseMetaDataIO[Boolean]

  120. def ownDeletesAreVisible(a: Int): DatabaseMetaDataIO[Boolean]

  121. def ownInsertsAreVisible(a: Int): DatabaseMetaDataIO[Boolean]

  122. def ownUpdatesAreVisible(a: Int): DatabaseMetaDataIO[Boolean]

  123. def raw[A](f: (DatabaseMetaData) ⇒ A): DatabaseMetaDataIO[A]

    Backdoor for arbitrary computations on the underlying DatabaseMetaData.

  124. val storesLowerCaseIdentifiers: DatabaseMetaDataIO[Boolean]

  125. val storesLowerCaseQuotedIdentifiers: DatabaseMetaDataIO[Boolean]

  126. val storesMixedCaseIdentifiers: DatabaseMetaDataIO[Boolean]

  127. val storesMixedCaseQuotedIdentifiers: DatabaseMetaDataIO[Boolean]

  128. val storesUpperCaseIdentifiers: DatabaseMetaDataIO[Boolean]

  129. val storesUpperCaseQuotedIdentifiers: DatabaseMetaDataIO[Boolean]

  130. val supportsANSI92EntryLevelSQL: DatabaseMetaDataIO[Boolean]

  131. val supportsANSI92FullSQL: DatabaseMetaDataIO[Boolean]

  132. val supportsANSI92IntermediateSQL: DatabaseMetaDataIO[Boolean]

  133. val supportsAlterTableWithAddColumn: DatabaseMetaDataIO[Boolean]

  134. val supportsAlterTableWithDropColumn: DatabaseMetaDataIO[Boolean]

  135. val supportsBatchUpdates: DatabaseMetaDataIO[Boolean]

  136. val supportsCatalogsInDataManipulation: DatabaseMetaDataIO[Boolean]

  137. val supportsCatalogsInIndexDefinitions: DatabaseMetaDataIO[Boolean]

  138. val supportsCatalogsInPrivilegeDefinitions: DatabaseMetaDataIO[Boolean]

  139. val supportsCatalogsInProcedureCalls: DatabaseMetaDataIO[Boolean]

  140. val supportsCatalogsInTableDefinitions: DatabaseMetaDataIO[Boolean]

  141. val supportsColumnAliasing: DatabaseMetaDataIO[Boolean]

  142. def supportsConvert(a: Int, b: Int): DatabaseMetaDataIO[Boolean]

  143. val supportsConvert: DatabaseMetaDataIO[Boolean]

  144. val supportsCoreSQLGrammar: DatabaseMetaDataIO[Boolean]

  145. val supportsCorrelatedSubqueries: DatabaseMetaDataIO[Boolean]

  146. val supportsDataDefinitionAndDataManipulationTransactions: DatabaseMetaDataIO[Boolean]

  147. val supportsDataManipulationTransactionsOnly: DatabaseMetaDataIO[Boolean]

  148. val supportsDifferentTableCorrelationNames: DatabaseMetaDataIO[Boolean]

  149. val supportsExpressionsInOrderBy: DatabaseMetaDataIO[Boolean]

  150. val supportsExtendedSQLGrammar: DatabaseMetaDataIO[Boolean]

  151. val supportsFullOuterJoins: DatabaseMetaDataIO[Boolean]

  152. val supportsGetGeneratedKeys: DatabaseMetaDataIO[Boolean]

  153. val supportsGroupBy: DatabaseMetaDataIO[Boolean]

  154. val supportsGroupByBeyondSelect: DatabaseMetaDataIO[Boolean]

  155. val supportsGroupByUnrelated: DatabaseMetaDataIO[Boolean]

  156. val supportsIntegrityEnhancementFacility: DatabaseMetaDataIO[Boolean]

  157. val supportsLikeEscapeClause: DatabaseMetaDataIO[Boolean]

  158. val supportsLimitedOuterJoins: DatabaseMetaDataIO[Boolean]

  159. val supportsMinimumSQLGrammar: DatabaseMetaDataIO[Boolean]

  160. val supportsMixedCaseIdentifiers: DatabaseMetaDataIO[Boolean]

  161. val supportsMixedCaseQuotedIdentifiers: DatabaseMetaDataIO[Boolean]

  162. val supportsMultipleOpenResults: DatabaseMetaDataIO[Boolean]

  163. val supportsMultipleResultSets: DatabaseMetaDataIO[Boolean]

  164. val supportsMultipleTransactions: DatabaseMetaDataIO[Boolean]

  165. val supportsNamedParameters: DatabaseMetaDataIO[Boolean]

  166. val supportsNonNullableColumns: DatabaseMetaDataIO[Boolean]

  167. val supportsOpenCursorsAcrossCommit: DatabaseMetaDataIO[Boolean]

  168. val supportsOpenCursorsAcrossRollback: DatabaseMetaDataIO[Boolean]

  169. val supportsOpenStatementsAcrossCommit: DatabaseMetaDataIO[Boolean]

  170. val supportsOpenStatementsAcrossRollback: DatabaseMetaDataIO[Boolean]

  171. val supportsOrderByUnrelated: DatabaseMetaDataIO[Boolean]

  172. val supportsOuterJoins: DatabaseMetaDataIO[Boolean]

  173. val supportsPositionedDelete: DatabaseMetaDataIO[Boolean]

  174. val supportsPositionedUpdate: DatabaseMetaDataIO[Boolean]

  175. def supportsResultSetConcurrency(a: Int, b: Int): DatabaseMetaDataIO[Boolean]

  176. def supportsResultSetHoldability(a: Int): DatabaseMetaDataIO[Boolean]

  177. def supportsResultSetType(a: Int): DatabaseMetaDataIO[Boolean]

  178. val supportsSavepoints: DatabaseMetaDataIO[Boolean]

  179. val supportsSchemasInDataManipulation: DatabaseMetaDataIO[Boolean]

  180. val supportsSchemasInIndexDefinitions: DatabaseMetaDataIO[Boolean]

  181. val supportsSchemasInPrivilegeDefinitions: DatabaseMetaDataIO[Boolean]

  182. val supportsSchemasInProcedureCalls: DatabaseMetaDataIO[Boolean]

  183. val supportsSchemasInTableDefinitions: DatabaseMetaDataIO[Boolean]

  184. val supportsSelectForUpdate: DatabaseMetaDataIO[Boolean]

  185. val supportsStatementPooling: DatabaseMetaDataIO[Boolean]

  186. val supportsStoredFunctionsUsingCallSyntax: DatabaseMetaDataIO[Boolean]

  187. val supportsStoredProcedures: DatabaseMetaDataIO[Boolean]

  188. val supportsSubqueriesInComparisons: DatabaseMetaDataIO[Boolean]

  189. val supportsSubqueriesInExists: DatabaseMetaDataIO[Boolean]

  190. val supportsSubqueriesInIns: DatabaseMetaDataIO[Boolean]

  191. val supportsSubqueriesInQuantifieds: DatabaseMetaDataIO[Boolean]

  192. val supportsTableCorrelationNames: DatabaseMetaDataIO[Boolean]

  193. def supportsTransactionIsolationLevel(a: Int): DatabaseMetaDataIO[Boolean]

  194. val supportsTransactions: DatabaseMetaDataIO[Boolean]

  195. val supportsUnion: DatabaseMetaDataIO[Boolean]

  196. val supportsUnionAll: DatabaseMetaDataIO[Boolean]

  197. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  198. def toString(): String

    Definition Classes
    AnyRef → Any
  199. def trans[M[_]](c: DatabaseMetaData)(implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[DatabaseMetaDataIO, M]

    Natural transformation from DatabaseMetaDataIO to M, given a java.sql.DatabaseMetaData.

  200. def transK[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[DatabaseMetaDataIO, [γ]Kleisli[M, DatabaseMetaData, γ]]

    Natural transformation from DatabaseMetaDataIO to Kleisli for the given M, consuming a java.sql.DatabaseMetaData.

  201. def unwrap[T](a: Class[T]): DatabaseMetaDataIO[T]

  202. def updatesAreDetected(a: Int): DatabaseMetaDataIO[Boolean]

  203. val usesLocalFilePerTable: DatabaseMetaDataIO[Boolean]

  204. val usesLocalFiles: DatabaseMetaDataIO[Boolean]

  205. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  206. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  207. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Algebra

Constructors (Lifting)

Constructors (Primitives)

Typeclass Instances

Ungrouped