https://github.com/jaytaylor/sql-layer

https://github.com/jaytaylor/sql-layer

Last synced: 15 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/jaytaylor/sql-layer
• Owner: jaytaylor
• License: agpl-3.0
• Created: 2015-03-25T18:51:56.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-03-25T18:54:58.000Z (over 9 years ago)
• Last Synced: 2024-07-31T20:34:43.614Z (3 months ago)
• Language: Java
• Size: 132 MB
• Stars: 92
• Watchers: 6
• Forks: 150
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-foundationdb - FoundationDB's original SQL layer

README

        
# FoundationDB SQL Layer

## Overview

The FoundationDB SQL layer is a full SQL implementation that builds on

[FoundationDB’s core features](https://foundationdb.com/features). It gets

the same high performance, multi-node scalability, fault-tolerance, and

true multi-key ACID transactions while also providing new capabilities,

including a sophisticated SQL environment and direct object access.

It was written from the ground up in Java and utilizes the

[FoundationDB SQL Parser](https://github.com/FoundationDB/sql-parser).

Check out https://foundationdb.com/layers/sql for the full documentation.

## Prerequisites

The FoundationDB SQL Layer requires Java 7 Runtime Environment and FoundationDB.

### JRE

The FoundationDB SQL Layer requires the Java 7 Runtime Environment (JRE). Both

OpenJDK JRE and the official Oracle JRE are supported.

See the [Oracle Java SE Downloads](http://www.oracle.com/technetwork/java/javase/downloads/index.html)

page for installation details.

### FoundationDB

To install FoundationDB, follow the official [Getting Started](https://foundationdb.com/documentation/getting-started.html)

guides, being sure to check that the cluster is up and running (covered

in *Testing your FoundationDB installation*).

## Installing the SQL Layer

The SQL Layer can be installed from system packages (appropriate for most

people) or directly from source (intended for developers).

### a. Packages

Official packages for Windows, OS X, Ubuntu and CentOS/RedHat are available.

See the [installation section](https://foundationdb.com/layers/sql/documentation/GettingStarted/index.html)

for more details.

A single instance of the SQL Layer is installed by default and is appropriate

for local development. Consult the documentation for recommended multi-node

configurations.

### b. Source

Note: This section is intended *only* for developers.

To build the SQL Layer from source code several steps need to be taken in advance. 

* Have the [FoundationDB key-value store](https://foundationdb.com/get) installed and running.

* Install Java Development Kit (JDK) version 7, either [OpenJDK](http://openjdk.java.net) 

or [Oracle JDK](http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html).

* Set the environment variable JAVA_HOME to the directory in which the JDK is installed.

* Install [Maven](http://maven.apache.org) version 3 to build the package.

* Install [Protobuf](https://code.google.com/p/protobuf/wiki/Download?tm=2) version 2.5.0.

  Installation instructions  are in their README.txt, it may require installation 

  of gpp. The Maven POM.xml file for building the SQL Layer

  assumes this directory is present in the parent directory of the SQL Layer. 

* Clone and build the [FoundationDB SQL Parser](https://github.com/FoundationDB/sql-parser) 

* Clone and build the [FoundationDB JDBC Driver](https://github.com/FoundationDB/sql-layer-adapter-jdbc) 

Not a prerequisite but recommended, you can install the 

[SQL Layer Client Tools](https://github.com/FoundationDB/sql-layer-client-tools) to 

interact with the SQL layer when it runs.

After installing the listed prerequisites, you can clone the project using git, and build the SQL Layer.

Move into the directory:

    $ cd sql-layer

Use Maven to build the project:

    $ mvn install

All unit and integration tests will be run by default, which could be lengthy.

Test execution can be avoided with the `skipTests` option:

    $ mvn install -DskipTests=true

An executable jar, and required dependencies, will be the `target/` directory

once packaging is complete.

The server can then be started with the `fdbsqllayer` script. The `-f` flag

will run it in the foreground:

    $ ./bin/fdbsqllayer -f

Or for Windows users:

    $ ./bin/fdbsqllayer.cmd -f

A handful of informational messages will print and then the server will state it is ready:

    2013-03-22 15:36:29,561 [main] INFO  ServiceManager - FoundationDB SQL Layer ready.

When installing from source, you'll also want the

[SQL Layer Client Tools](https://github.com/FoundationDB/sql-layer-client-tools).

## 5. Testing Your SQL Layer Installation

The SQL Layer can then be accessed using the SQL client on port `15432`:

    $ fdbsqlcli -c 'SELECT VERSION();'

            _SQL_COL_1         

    --------------------------

     FoundationDB x.y.z +hash 

    (1 row)

And using a RESTful API on port `8091`:

    $ curl http://localhost:8091/v1/version

    [

    {"server_name":"FoundationDB SQL Layer","server_version":"x.y.z+hash"}

    ]

## Contact

* GitHub: http://github.com/FoundationDB/sql-layer

* Community: https://foundationdb.com/community

* IRC: #FoundationDB on irc.freenode.net