Skip to content
Permalink
Browse files

Some documentation improvements and fixes

  • Loading branch information...
szeiger committed Aug 6, 2012
1 parent ed00dfb commit 9de2e78ab304df4e850c39b58df0c9aaf02a2181
Showing with 22 additions and 14 deletions.
  1. +3 −3 src/sphinx/direct-embedding.rst
  2. +5 −5 src/sphinx/gettingstarted.rst
  3. +10 −6 src/sphinx/index.rst
  4. +4 −0 src/sphinx/lifted-embedding.rst
@@ -1,5 +1,5 @@
Direct embedding
===================
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.
@@ -24,7 +24,7 @@ Query
------------
Queryable takes an annotated case class as its type argument to formulate queries agains the corresponding table.

_.price is of type Int here. The underlying, macro-based implementation takes care of that the shown arguments to map
``_.price`` is of type Int here. The underlying, macro-based implementation takes care of that the shown arguments to map
and filter are not executed on the JVM but translated to database queries instead.

.. includecode:: code/DirectEmbedding.scala#query
@@ -75,15 +75,15 @@ In a Java SE environment, database sessions are usually created by connecting
to a JDBC URL using a JDBC driver class (see the JDBC driver's documentation
for the correct URL syntax). If you are only using
:doc:`plain SQL queries <sql>`, nothing more is required, but when Slick is
generating SQL code for you (using :doc:`the direct embedding <queryable>` or
the :doc:`lifted embedding <ql>`), you need to make sure to use a matching
Slick driver (in our case the ``H2Driver`` import above).
generating SQL code for you (using the :doc:`direct embedding <direct-embedding>`
or the :doc:`lifted embedding <lifted-embedding>`), you need to make sure to use
a matching Slick driver (in our case the ``H2Driver`` import above).

Schema
------

We are using the :doc:`lifted embedding <ql>` in this application, so we have to
write ``Table`` objects for our database tables:
We are using the :doc:`lifted embedding <lifted-embedding>` in this
application, so we have to write ``Table`` objects for our database tables:

.. includecode:: code/FirstExample.scala#tables

@@ -1,12 +1,13 @@
Slick - Scala Language Integrated Connection Kit
################################################

Project Slick (Scala Language Integrated Connection Kit) aims at the
development of a complete, modern, convenient, efficient and safe data query
and access framework for the Scala programming language that operates on the
Java platform. Ordinary Scala code can be used to query different database
back-ends. Queries can be processed and validated at compile time, even in
user-provided back-ends.
Slick is a modern database query and access library for Scala. It allows you
to work with stored data almost as if you were using Scala collections while
at the same time giving you full control over when a database access happens
and which data is transferred. You can write your database queries in Scala
instead of SQL, thus profiting from the static checking, compile-time safety
and compositionality of Scala. Slick features an extensible query compiler
which can generate code for different backends.

It includes the following features:

@@ -34,6 +35,9 @@ The following database systems are directly supported for type-safe queries

Accessing other databases is possible, with a reduced feature set.

Table of Contents
-----------------

.. toctree::
:maxdepth: 4

@@ -0,0 +1,4 @@
Lifted Embedding
================

tbd

0 comments on commit 9de2e78

Please sign in to comment.
You can’t perform that action at this time.