Class

slick.jdbc.JdbcBackend

DatabaseDef

Related Doc: package JdbcBackend

Permalink

class DatabaseDef extends JdbcBackend.DatabaseDef

Source
JdbcBackend.scala
Linear Supertypes
JdbcBackend.DatabaseDef, Closeable, AutoCloseable, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DatabaseDef
  2. DatabaseDef
  3. Closeable
  4. AutoCloseable
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DatabaseDef(source: JdbcDataSource, executor: AsyncExecutor)

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from DatabaseDef to any2stringadd[DatabaseDef] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (DatabaseDef, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from DatabaseDef to ArrowAssoc[DatabaseDef] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def acquireSession(ctx: Context): Unit

    Permalink

    Within a synchronous execution, ensure that a Session is available.

    Within a synchronous execution, ensure that a Session is available.

    Attributes
    protected[this]
    Definition Classes
    DatabaseDef
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. var capabilities: DatabaseCapabilities

    Permalink

    The DatabaseCapabilities, accessed through a Session and created by the first Session that needs them.

    The DatabaseCapabilities, accessed through a Session and created by the first Session that needs them. Access does not need to be synchronized because, in the worst case, capabilities will be determined multiple times by different concurrent sessions but the result should always be the same.

    Attributes
    protected[slick.jdbc.JdbcBackend]
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def close(): Unit

    Permalink

    Free all resources allocated by Slick for this Database object.

    Free all resources allocated by Slick for this Database object. In particular, the slick.util.AsyncExecutor with the thread pool for asynchronous execution is shut down. If this object represents a connection pool managed directly by Slick, it is also closed.

    Definition Classes
    DatabaseDefDatabaseDef → Closeable → AutoCloseable
  11. def createDatabaseActionContext[T](_useSameThread: Boolean): Context

    Permalink

    Create the default DatabaseActionContext for this backend.

    Create the default DatabaseActionContext for this backend.

    Attributes
    protected[this]
    Definition Classes
    DatabaseDefDatabaseDef
  12. def createPublisher[T](a: DBIOAction[_, Streaming[T], Nothing], createCtx: (Subscriber[_ >: T]) ⇒ StreamingContext): DatabasePublisher[T]

    Permalink

    Create a Reactive Streams Publisher using the given context factory.

    Create a Reactive Streams Publisher using the given context factory.

    Attributes
    protected[this]
    Definition Classes
    DatabaseDef
  13. def createSession(): Session

    Permalink

    Create a new session.

    Create a new session. The session needs to be closed explicitly by calling its close() method.

    Definition Classes
    DatabaseDefDatabaseDef
  14. def createStreamingDatabaseActionContext[T](s: Subscriber[_ >: T], useSameThread: Boolean): StreamingContext

    Permalink

    Create the default StreamingDatabaseActionContext for this backend.

    Create the default StreamingDatabaseActionContext for this backend.

    Attributes
    protected[this]
    Definition Classes
    DatabaseDefDatabaseDef
  15. def ensuring(cond: (DatabaseDef) ⇒ Boolean, msg: ⇒ Any): DatabaseDef

    Permalink
    Implicit information
    This member is added by an implicit conversion from DatabaseDef to Ensuring[DatabaseDef] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (DatabaseDef) ⇒ Boolean): DatabaseDef

    Permalink
    Implicit information
    This member is added by an implicit conversion from DatabaseDef to Ensuring[DatabaseDef] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: ⇒ Any): DatabaseDef

    Permalink
    Implicit information
    This member is added by an implicit conversion from DatabaseDef to Ensuring[DatabaseDef] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): DatabaseDef

    Permalink
    Implicit information
    This member is added by an implicit conversion from DatabaseDef to Ensuring[DatabaseDef] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  21. val executor: AsyncExecutor

    Permalink
  22. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from DatabaseDef to StringFormat[DatabaseDef] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  24. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  25. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  26. final def io[T](thunk: ⇒ T): Future[T]

    Permalink

    Run some code on the ioExecutionContext.

  27. final def ioExecutionContext: ExecutionContext

    Permalink

    The ExecutionContext which is used for performing blocking database I/O, similar to how run or stream would run it.

    The ExecutionContext which is used for performing blocking database I/O, similar to how run or stream would run it. This can be used for calling back into blocking JDBC APIs (e.g. for materializing a LOB or mutating a result set row) from asynchronous processors of unbuffered streams.

  28. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  29. def logAction(a: DBIOAction[_, NoStream, Nothing], ctx: Context): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    DatabaseDef
  30. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  31. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  33. final def releaseSession(ctx: Context, discardErrors: Boolean): Unit

    Permalink

    Within a synchronous execution, close the current Session unless it is pinned.

    Within a synchronous execution, close the current Session unless it is pinned.

    discardErrors

    If set to true, swallow all non-fatal errors that arise while closing the Session.

    Attributes
    protected[this]
    Definition Classes
    DatabaseDef
  34. final def run[R](a: DBIOAction[R, NoStream, Nothing]): Future[R]

    Permalink

    Run an Action asynchronously and return the result as a Future.

    Run an Action asynchronously and return the result as a Future.

    Definition Classes
    DatabaseDef
  35. def runInContext[R](a: DBIOAction[R, NoStream, Nothing], ctx: Context, streaming: Boolean, topLevel: Boolean): Future[R]

    Permalink

    Run an Action in an existing DatabaseActionContext.

    Run an Action in an existing DatabaseActionContext. This method can be overridden in subclasses to support new DatabaseActions which cannot be expressed through SynchronousDatabaseAction.

    streaming

    Whether to return the result as a stream. In this case, the context must be a StreamingDatabaseActionContext and the Future result should be completed with null or failed after streaming has finished. This method should not call any Subscriber method other than onNext.

    Attributes
    protected[this]
    Definition Classes
    DatabaseDef
  36. def runSynchronousDatabaseAction[R](a: SynchronousDatabaseAction[R, NoStream, This, _], ctx: Context, continuation: Boolean): Future[R]

    Permalink

    Run a SynchronousDatabaseAction on this database.

    Run a SynchronousDatabaseAction on this database.

    Attributes
    protected[this]
    Definition Classes
    DatabaseDef
  37. def scheduleSynchronousStreaming(a: SynchronousDatabaseAction[_, _ <: NoStream, This, _ <: Effect], ctx: StreamingContext, continuation: Boolean)(initialState: StreamState): Unit

    Permalink

    Stream a part of the results of a SynchronousDatabaseAction on this database.

    Stream a part of the results of a SynchronousDatabaseAction on this database.

    Attributes
    protected[slick.basic.BasicBackend]
    Definition Classes
    DatabaseDef
  38. def shutdown: Future[Unit]

    Permalink

    Free all resources allocated by Slick for this Database.

    Free all resources allocated by Slick for this Database. This is done asynchronously, so you need to wait for the returned Future to complete in order to ensure that everything has been shut down.

    Definition Classes
    DatabaseDef
  39. val source: JdbcDataSource

    Permalink
  40. final def stream[T](a: StreamingDBIO[_, T], bufferNext: Boolean): DatabasePublisher[T]

    Permalink

    Like stream(StreamingAction) but you can disable pre-buffering of the next row by setting bufferNext = false.

    Like stream(StreamingAction) but you can disable pre-buffering of the next row by setting bufferNext = false. The ResultSet will not advance to the next row until you request() more data. This allows you to process LOBs asynchronously by requesting only one single element at a time after processing the current one, so that the proper sequencing is preserved even though processing may happen on a different thread.

  41. final def stream[T](a: DBIOAction[_, Streaming[T], Nothing]): DatabasePublisher[T]

    Permalink

    Create a Publisher for Reactive Streams which, when subscribed to, will run the specified DBIOAction and return the result directly as a stream without buffering everything first.

    Create a Publisher for Reactive Streams which, when subscribed to, will run the specified DBIOAction and return the result directly as a stream without buffering everything first. This method is only supported for streaming actions.

    The Publisher itself is just a stub that holds a reference to the action and this Database. The action does not actually start to run until the call to onSubscribe returns, after which the Subscriber is responsible for reading the full response or cancelling the Subscription. The created Publisher can be reused to serve a multiple Subscribers, each time triggering a new execution of the action.

    For the purpose of combinators such as cleanup which can run after a stream has been produced, cancellation of a stream by the Subscriber is not considered an error. For example, there is no way for the Subscriber to cause a rollback when streaming the results of someQuery.result.transactionally.

    When using a JDBC back-end, all onNext calls are done synchronously and the ResultSet row is not advanced before onNext returns. This allows the Subscriber to access LOB pointers from within onNext. If streaming is interrupted due to back-pressure signaling, the next row will be prefetched (in order to buffer the next result page from the server when a page boundary has been reached).

    Definition Classes
    DatabaseDef
  42. def streamSynchronousDatabaseAction(a: SynchronousDatabaseAction[_, _ <: NoStream, This, _ <: Effect], ctx: StreamingContext, continuation: Boolean): Future[Null]

    Permalink

    Stream a SynchronousDatabaseAction on this database.

    Stream a SynchronousDatabaseAction on this database.

    Attributes
    protected[this]
    Definition Classes
    DatabaseDef
  43. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  44. def synchronousExecutionContext: ExecutionContext

    Permalink

    Return the default ExecutionContet for this Database which should be used for running SynchronousDatabaseActions for asynchronous execution.

    Return the default ExecutionContet for this Database which should be used for running SynchronousDatabaseActions for asynchronous execution.

    Attributes
    protected[this]
    Definition Classes
    DatabaseDefDatabaseDef
  45. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  46. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. def [B](y: B): (DatabaseDef, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from DatabaseDef to ArrowAssoc[DatabaseDef] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from JdbcBackend.DatabaseDef

Inherited from Closeable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from DatabaseDef to any2stringadd[DatabaseDef]

Inherited by implicit conversion StringFormat from DatabaseDef to StringFormat[DatabaseDef]

Inherited by implicit conversion Ensuring from DatabaseDef to Ensuring[DatabaseDef]

Inherited by implicit conversion ArrowAssoc from DatabaseDef to ArrowAssoc[DatabaseDef]

Ungrouped