doobie.package.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of doobie-core_2.13 Show documentation

Pure functional JDBC layer for Scala.

There is a newer version: 1.0.0-RC6

// Copyright (c) 2013-2020 Rob Norris and Contributors
// This software is licensed under the MIT License (MIT).
// For more information see LICENSE or https://opensource.org/licenses/MIT

import doobie.util.meta.{LegacyMeta, TimeMetaInstances}
// Copyright (c) 2013-2020 Rob Norris and Contributors
// This software is licensed under the MIT License (MIT).
// For more information see LICENSE or https://opensource.org/licenses/MIT

/** Top-level import, providing aliases for the most commonly used types and modules from doobie-free and doobie-core. A
  * typical starting set of imports would be something like this.
  * {{{
  * import cats.implicits._
  * import doobie._, doobie.implicits._
  * }}}
  * @see
  *   The [[http://tpolecat.github.io/doobie/ doobie microsite]] for much more information.
  */
package object doobie
    extends Aliases
    with doobie.hi.Modules
    with doobie.free.Modules
    with doobie.free.Types {

  /** Top-level import for all instances and syntax provided by doobie-free and doobie-core. */
  object implicits
      extends free.Instances
      with generic.AutoDerivation
      with LegacyMeta
      with syntax.AllSyntax {

    /** Only use this import if:
      *   1. You're NOT using one of the database doobie has direct java.time isntances for (PostgreSQL / MySQL). (They
      *      have more accurate column type checks) 2. Your driver natively supports java.time.* types
      *
      * If your driver doesn't support java.time.* types, use [[doobie.implicits.legacy.instant/localdate]] instead
      */
    object javatimedrivernative extends TimeMetaInstances
  }

}