Packages

o

org.apache.spark.sql.jdbc

JdbcDialects

object JdbcDialects

:: DeveloperApi :: Registry of dialects that apply to every new jdbc org.apache.spark.sql.DataFrame.

If multiple matching dialects are registered then all matching ones will be tried in reverse order. A user-added dialect will thus be applied first, overwriting the defaults.

Annotations
@DeveloperApi()
Source
JdbcDialects.scala
Note

All new dialects are applied to new jdbc DataFrames only. Make sure to register your dialects first.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JdbcDialects
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def get(url: String): JdbcDialect

    Fetch the JdbcDialect class corresponding to a given database url.

  9. def getBuiltInDialect(name: String): JdbcDialect

    Return a built-in JDBC dialect by name.

    Return a built-in JDBC dialect by name. The lookup is case-insensitive. Supported names are mysql, postgresql, db2, sqlserver, derby, oracle, teradata, h2, snowflake, and databricks.

    name

    The name of the built-in JDBC dialect.

    Annotations
    @Since("4.3.0")
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  16. def registerDialect(dialect: JdbcDialect): Unit

    Register a dialect for use on all new matching jdbc org.apache.spark.sql.DataFrame.

    Register a dialect for use on all new matching jdbc org.apache.spark.sql.DataFrame. Reading an existing dialect will cause a move-to-front.

    dialect

    The new dialect.

  17. def registerDialectForUrlPrefix(urlPrefix: String, dialect: JdbcDialect): Unit

    Register an existing dialect for an additional JDBC URL prefix.

    Register an existing dialect for an additional JDBC URL prefix. The registration affects dialect lookup only; Spark still passes the original URL to the JDBC driver. Registering the same prefix again replaces its previous dialect. These registrations are used only when no registered dialect handles the URL through JdbcDialect#canHandle.

    The prefix must start with jdbc: and end with :. Matching is case-insensitive. For example, a MySQL-compatible wrapper can reuse the built-in MySQL dialect:

    JdbcDialects.registerDialectForUrlPrefix(
  "jdbc:aws-wrapper:mysql:",
  JdbcDialects.getBuiltInDialect("mysql"))
    urlPrefix

    The additional JDBC URL prefix.

    dialect

    The existing dialect to use for URLs with the prefix.

    Annotations
    @Since("4.3.0")
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. def unregisterDialect(dialect: JdbcDialect): Unit

    Unregister a dialect.

    Unregister a dialect. Does nothing if the dialect is not registered.

    dialect

    The jdbc dialect.

  21. def unregisterDialectForUrlPrefix(urlPrefix: String): Unit

    Unregister the dialect associated with an additional JDBC URL prefix.

    Unregister the dialect associated with an additional JDBC URL prefix. Does nothing if the prefix is not registered.

    urlPrefix

    The additional JDBC URL prefix.

    Annotations
    @Since("4.3.0")
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped