Quidem (Quidem 0.9 API)

java.lang.Object
- net.hydromatic.quidem.Quidem

```
public class Quidem
extends Object
```
Runs a SQL script.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static interface`	`Quidem.Config`	The information needed to start Quidem.
`static class`	`Quidem.ConfigBuilder`	Builds a `Quidem.Config`.
`static interface`	`Quidem.ConnectionFactory`	Creates a connection for a given name.
`static interface`	`Quidem.PropertyHandler`	Called whenever a property's value is changed.
`static class`	`Quidem.SqlCommand`	Command that executes a SQL statement.

Field Summary

Fields
Modifier and Type	Field	Description
`static boolean`	`DEBUG`
`static CommandHandler`	`EMPTY_COMMAND_HANDLER`	A command handler that defines no commands.
`static Quidem.ConnectionFactory`	`EMPTY_CONNECTION_FACTORY`	The empty environment.
`static java.util.function.Function<String,Object>`	`EMPTY_ENV`	The empty environment.
`static Quidem.PropertyHandler`	`EMPTY_PROPERTY_HANDLER`	A property handler that does nothing.

Constructor Summary

Constructors
Constructor	Description
`Quidem(Reader reader, Writer writer)`	Creates a Quidem interpreter with an empty environment and empty connection factory.
`Quidem(Reader reader, Writer writer, java.util.function.Function<String,Object> env, Quidem.ConnectionFactory connectionFactory)`	Deprecated. Use `Quidem(Config)` and `Quidem.ConfigBuilder`
`Quidem(Quidem.Config config)`	Creates a Quidem interpreter.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static Quidem.ConfigBuilder`	`configBuilder()`	Creates a `Quidem.ConfigBuilder` with the default settings.
`protected void`	`echo(Iterable<String> lines)`
`void`	`execute()`	Executes the commands from the input, writing to the output, then closing both input and output.
`boolean`	`isProbablyDeterministic(String sql)`	Returns whether a SQL query is likely to produce results always in the same order.
`static void`	`main(String[] args)`	Entry point from the operating system command line.
`void`	`setStackLimit(int stackLimit)`	Deprecated. Use `Quidem.ConfigBuilder.withStackLimit(int)`.
`Quidem`	`withConnectionFactory(Quidem.ConnectionFactory connectionFactory)`	Deprecated. Use `Quidem.ConfigBuilder.withConnectionFactory(ConnectionFactory)`
`Quidem`	`withPropertyHandler(Quidem.PropertyHandler propertyHandler)`	Deprecated. Use `Quidem.ConfigBuilder.withPropertyHandler(PropertyHandler)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEBUG
```
public static final boolean DEBUG
```
  - EMPTY_ENV
```
public static final java.util.function.Function<String,Object> EMPTY_ENV
```
    The empty environment. Returns null for all variables.
  - EMPTY_CONNECTION_FACTORY
```
public static final Quidem.ConnectionFactory EMPTY_CONNECTION_FACTORY
```
    The empty environment. Returns null for all database names.
  - EMPTY_COMMAND_HANDLER
```
public static final CommandHandler EMPTY_COMMAND_HANDLER
```
    A command handler that defines no commands.
  - EMPTY_PROPERTY_HANDLER
```
public static final Quidem.PropertyHandler EMPTY_PROPERTY_HANDLER
```
    A property handler that does nothing.
- Constructor Detail
  - Quidem
```
public Quidem(Reader reader,
              Writer writer)
```
    Creates a Quidem interpreter with an empty environment and empty connection factory.
  - Quidem
```
@Deprecated
public Quidem(Reader reader,
              Writer writer,
              java.util.function.Function<String,Object> env,
              Quidem.ConnectionFactory connectionFactory)
```
    Deprecated. Use Quidem(Config) and Quidem.ConfigBuilder
  - Quidem
```
public Quidem(Quidem.Config config)
```
    Creates a Quidem interpreter.
- Method Detail
  - configBuilder
```
public static Quidem.ConfigBuilder configBuilder()
```
    Creates a Quidem.ConfigBuilder with the default settings.
  - withConnectionFactory
```
@Deprecated
public Quidem withConnectionFactory(Quidem.ConnectionFactory connectionFactory)
```
    Deprecated. Use Quidem.ConfigBuilder.withConnectionFactory(ConnectionFactory)
  - withPropertyHandler
```
@Deprecated
public Quidem withPropertyHandler(Quidem.PropertyHandler propertyHandler)
```
    Deprecated. Use Quidem.ConfigBuilder.withPropertyHandler(PropertyHandler)
  - main
```
public static void main(String[] args)
```
    Entry point from the operating system command line.
    Calls System.exit(int) with the following status codes:
    - 0: success
    - 1: invalid arguments
    - 2: help
    Parameters:
    
    args - Command-line arguments
  - execute
```
public void execute()
```
    Executes the commands from the input, writing to the output, then closing both input and output.
  - echo
```
protected void echo(Iterable<String> lines)
```
  - setStackLimit
```
@Deprecated
public void setStackLimit(int stackLimit)
```
    Deprecated. Use Quidem.ConfigBuilder.withStackLimit(int).
  - isProbablyDeterministic
```
public boolean isProbablyDeterministic(String sql)
```
    Returns whether a SQL query is likely to produce results always in the same order.
    If Quidem believes that the order is deterministic, it does not sort the rows before comparing them.
    The result is just a guess. Quidem does not understand the finer points of SQL semantics.
    
    Parameters:
    
    sql - SQL query
    
    Returns:
    
    Whether the order is likely to be deterministic

Class Quidem

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEBUG

EMPTY_ENV

EMPTY_CONNECTION_FACTORY

EMPTY_COMMAND_HANDLER

EMPTY_PROPERTY_HANDLER

Constructor Detail

Quidem

Quidem

Quidem

Method Detail

configBuilder

withConnectionFactory

withPropertyHandler

main

execute

echo

setStackLimit

isProbablyDeterministic