diff --git a/jOOQ-website/src/main/resources/manual-3.2.xml b/jOOQ-website/src/main/resources/manual-3.2.xml index fa98cd4598..e15c5fa7c0 100644 --- a/jOOQ-website/src/main/resources/manual-3.2.xml +++ b/jOOQ-website/src/main/resources/manual-3.2.xml @@ -83,7 +83,7 @@

This section is dedicated to tools that ship with jOOQ, such as the - jOOQ console + jOOQ's JDBC mocking feature

  • @@ -398,7 +398,7 @@ CREATE TABLE book_to_book_store (
  • Typesafe SQL construction through a complete API modelling SQL as a domain specific language in Java (see the chapter about )
  • Convenient query execution through an improved API for result fetching (see the chapters about )
  • SQL dialect abstraction and SQL clause simulation to improve cross-database compatibility and to enable missing features in simpler databases (see the chapter about )
    • -
  • SQL logging and debugging using jOOQ as an integral part of your development process (see the chapters about and about the )
    • +
  • SQL logging and debugging using jOOQ as an integral part of your development process (see the chapters about )

    • Effectively, jOOQ was originally designed to replace any other database abstraction framework short of the ones handling connection pooling and transaction management (see also the ) @@ -561,7 +561,6 @@ for (AuthorRecord author : create.fetch(AUTHOR)) { jOOQ isn't just a library that helps you and SQL against your . jOOQ ships with a lot of tools. Here are some of the most important tools shipped with jOOQ:

    @@ -8862,7 +8860,7 @@ public class PrettyPrinter extends DefaultExecuteListener { } }]]>

    - See also the manual's sections about and the for more sample implementations of actual ExecuteListeners. + See also the manual's sections about for more sample implementations of actual ExecuteListeners.

    Example: Bad query execution ExecuteListener

    @@ -10225,130 +10223,8 @@ Result result = create.selectFrom(BOOK).where(BOOK.ID.equal(5)).fetc jOOQ Console

    - The was driven by a feature request by Christopher Deckers, who has had the courtesy to contribute the jOOQ Console, a sample application interfacing with jOOQ's ExecuteListeners. The jOOQ Console logs all queries executed by jOOQ and displays them nicely in a Swing application. With the jOOQ Console's logger, you can: + The jOOQ Console is no longer supported or shipped with jOOQ 3.2+. You may still use the jOOQ 3.1 Console with new versions of jOOQ, at your own risk.

    -
      -
    • Activate the console's DebugListener anytime (in-process or if the remote server is active).
      • -
    • View simple and batch queries and their parameters.
      • -
    • Reformat queries along with syntax highlighting for better readability.
      • -
    • View stack trace of originator of the call.
      • -
    • Dump the stack to stdout when in an IDE, to directly navigate to relevant classes.
      • -
    • Track execution time, binding time, parsing time, rows read, fields read.
      • -
    • Show/hide queries depending on their type (SELECT, UPDATE, etc.).
      • -
    • Sort any column (timing columns, queries, types, etc.)
      • -
    • Easy copy paste of rows/columns to Spreadsheet editors.
      • -
    - -

    - A short overview of such a debugging session can be seen here: -

    -
    - jOOQ Console example -
    -

    - Please note that the jOOQ Console is still experimental. Any feedback is very welcome on
    - the jooq-user group -

    - -

    jOOQ Console operation modes

    -

    - The jOOQ Console can be run in two different modes: -

    -
      -
    • In-process mode: running in the same process as the queries you're analysing
      • -
    • "headless" mode: running remotely
      • -
    - -

    - Both modes will require that you set the in the Configuration: -

    - - - -

    In-process mode

    -

    - The in-process mode is useful for Swing applications or other, locally run Java programs accessing the database via jOOQ. In order to launch the jOOQ Console "in-process", specify the previously documented settings and launch the Console as follows: -

    - - - -

    - Only in the in-process mode, you can execute ad-hoc queries directly from the console, if you provide it with proper DatabaseDescriptor. These queries are executed from the Editor pane which features: -

    -
      -
    • SQL editing within the console.
      • -
    • Incremental search on tables.
      • -
    • Simple code completion with tables/columns/SQL keywords.
      • -
    • Syntax highlighting and formatting capabilities.
      • -
    • Results shown in one or several tabs.
      • -
    • Easy analysis of Logger output by copy/pasting/running queries in the Editor.
      • -
    -
    - jOOQ Console example -
    - -

    "Headless" mode

    -

    - In J2EE or other server/client environments, you may not be able to run the console in the same process as your application. You can then run the jOOQ Console in "headless" mode. In addition to the previously documented settings, you'll have to start a debugger server in your application process, that the console can connect to: -

    - -// Create a new RemoteDebuggerServer in your application that listens to -// incoming connections on a given port -SERVER = new RemoteDebuggerServer(DEBUGGER_PORT); - -

    - Now start your application along with the debugger server and launch the console with this command: -

    - -java -jar jooq-console-{jooq-version}.jar [host] [port] - -

    - Depending on your distribution, you may have to manually add rsyntaxtextarea-2.0.2.jar and jOOQ artefacts on your classpath. -

    @@ -11104,7 +10980,6 @@ Condition condition3 = BOOK.TITLE.isNotDistinctFrom(possiblyNull);]]> Predicate Configuration Connection - Console CRUD -> OLTP DAO Database