Skip to content

Commit

Permalink
minor changes to direct embedding docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cvogt committed Feb 6, 2013
1 parent ab36677 commit 6397753
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
8 changes: 5 additions & 3 deletions src/sphinx/direct-embedding.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
Direct Embedding
================

The direct embedding is a new, experimental front-end for writing queries. The API may change without deprecation during experimental status.
Unlike the (stable) lifted embedding, the direct embedding uses macros instead of operator overloading and implicit conversions for its implementation.
The direct embedding is a new, still incomplete, experimental Query API under development.
It may change without deprecation period in any release during its experimental status.
There is no plan to replace the stable lifted embedding Query API, which you can safely bet on for production use. The direct embedding co-exists.
Unlike the lifted embedding, the direct embedding uses macros instead of operator overloading and implicit conversions for its implementation.
For a user the difference in the code is small, but queries using the direct embedding work with ordinary Scala types,
which can make error messages easier to understand.

Expand Down Expand Up @@ -83,5 +85,5 @@ Queries may result in sequences of arbitrarily nested tuples, which may also con

.. includecode:: code/DirectEmbedding.scala#nesting

The direct embedding currently does not feature insertion of data. Instead we can use the :doc:`lifted embedding <lifted-embedding>` or :doc:`plain SQL queries <sql>`.
The direct embedding currently does not feature insertion of data. Instead you can use the :doc:`lifted embedding <lifted-embedding>` or :doc:`plain SQL queries <sql>`.

2 changes: 1 addition & 1 deletion src/sphinx/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Slick - Scala Language Integrated Connection Kit
introduction
gettingstarted
lifted-embedding
direct-embedding
sql
direct-embedding
testkit
extensions

0 comments on commit 6397753

Please sign in to comment.