Packages

case class JdbcTableConnection(id: ConnectionId, url: String, driver: String, authMode: Option[AuthMode] = None, db: Option[String] = None, maxParallelConnections: Int = 1, connectionPoolMaxIdleTimeSec: Int = 3, metadata: Option[ConnectionMetadata] = None) extends Connection with SmartDataLakeLogger with Product with Serializable

Connection information for jdbc tables. If authentication is needed, user and password must be provided.

id

unique id of this connection

url

jdbc connection url

driver

class name of jdbc driver

authMode

optional authentication information: for now BasicAuthMode is supported.

db

jdbc database

maxParallelConnections

number of parallel jdbc connections created by an instance of this connection Note that Spark manages JDBC Connections on its own. This setting only applies to JDBC connection used by SDL for validating metadata or pre/postSQL.

connectionPoolMaxIdleTimeSec

timeout to close unused connections in the pool

Annotations
@Scaladoc()
Linear Supertypes
Serializable, Serializable, Product, Equals, SmartDataLakeLogger, Connection, AtlasExportable, ParsableFromConfig[Connection], SdlConfigObject, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JdbcTableConnection
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. SmartDataLakeLogger
  7. Connection
  8. AtlasExportable
  9. ParsableFromConfig
  10. SdlConfigObject
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new JdbcTableConnection(id: ConnectionId, url: String, driver: String, authMode: Option[AuthMode] = None, db: Option[String] = None, maxParallelConnections: Int = 1, connectionPoolMaxIdleTimeSec: Int = 3, metadata: Option[ConnectionMetadata] = None)

    id

    unique id of this connection

    url

    jdbc connection url

    driver

    class name of jdbc driver

    authMode

    optional authentication information: for now BasicAuthMode is supported.

    db

    jdbc database

    maxParallelConnections

    number of parallel jdbc connections created by an instance of this connection Note that Spark manages JDBC Connections on its own. This setting only applies to JDBC connection used by SDL for validating metadata or pre/postSQL.

    connectionPoolMaxIdleTimeSec

    timeout to close unused connections in the pool

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def atlasName: String
    Definition Classes
    Connection → AtlasExportable
  6. def atlasQualifiedName(prefix: String): String
    Definition Classes
    AtlasExportable
  7. val authMode: Option[AuthMode]
  8. val catalog: JdbcCatalog
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  10. val connectionPoolMaxIdleTimeSec: Int
  11. def createTableFromSchema(tableName: String, schema: StructType, rawOptions: Map[String, String])(implicit session: SparkSession): Unit

    Code partly copied from Spark:JdbcUtils to adapt schemaString method to not quote identifiers if Spark is in case-insensitive mode.

    Code partly copied from Spark:JdbcUtils to adapt schemaString method to not quote identifiers if Spark is in case-insensitive mode.

    Annotations
    @Scaladoc()
  12. val db: Option[String]
  13. val driver: String
  14. def dropTable(tableName: String, logging: Boolean = true): Boolean
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def execJdbcQuery[A](sql: String, evalResultSet: (ResultSet) ⇒ A): A

    Execute an SQL query and evaluate its ResultSet

    Execute an SQL query and evaluate its ResultSet

    sql

    sql query to execute

    evalResultSet

    function to evaluate the JDBC ResultSet

    returns

    the evaluated result

    Annotations
    @Scaladoc()
  17. def execJdbcStatement(sql: String, logging: Boolean = true, doCommit: Boolean = false): Boolean

    Execute an SQL statement

    Execute an SQL statement

    returns

    true if the first result is a ResultSet object; false if it is an update count or there are no results

    Annotations
    @Scaladoc()
  18. def execWithJdbcConnection[A](func: (java.sql.Connection) ⇒ A): A

    Get a connection from the pool and execute an arbitrary function

    Get a connection from the pool and execute an arbitrary function

    Annotations
    @Scaladoc()
  19. def execWithJdbcStatement[A](doCommit: Boolean = false)(func: (Statement) ⇒ A): A

    Get a JDBC connection from the pool, create a JDBC statement and execute an arbitrary function

    Get a JDBC connection from the pool, create a JDBC statement and execute an arbitrary function

    Annotations
    @Scaladoc()
  20. def factory: FromConfigFactory[Connection]

    Returns the factory that can parse this type (that is, type CO).

    Returns the factory that can parse this type (that is, type CO).

    Typically, implementations of this method should return the companion object of the implementing class. The companion object in turn should implement FromConfigFactory.

    returns

    the factory (object) for this class.

    Definition Classes
    JdbcTableConnection → ParsableFromConfig
  21. def getAuthModeSparkOptions: Map[String, String]
  22. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. val id: ConnectionId

    A unique identifier for this instance.

    A unique identifier for this instance.

    Definition Classes
    JdbcTableConnection → Connection → SdlConfigObject
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. lazy val logger: Logger
    Attributes
    protected
    Definition Classes
    SmartDataLakeLogger
    Annotations
    @transient()
  26. val maxParallelConnections: Int
  27. val metadata: Option[ConnectionMetadata]

    Additional metadata for the Connection

    Additional metadata for the Connection

    Definition Classes
    JdbcTableConnection → Connection
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. val pool: GenericObjectPool[java.sql.Connection]
  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. def test(): Unit
  34. def toStringShort: String
    Definition Classes
    Connection
  35. val url: String
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SmartDataLakeLogger

Inherited from Connection

Inherited from AtlasExportable

Inherited from ParsableFromConfig[Connection]

Inherited from SdlConfigObject

Inherited from AnyRef

Inherited from Any

Ungrouped