{"id":13409155,"url":"https://github.com/jaytaylor/sql-layer","last_synced_at":"2025-10-07T17:59:09.884Z","repository":{"id":29350167,"uuid":"32884360","full_name":"jaytaylor/sql-layer","owner":"jaytaylor","description":null,"archived":false,"fork":false,"pushed_at":"2015-03-25T18:54:58.000Z","size":138665,"stargazers_count":92,"open_issues_count":1,"forks_count":150,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-07-31T20:34:43.614Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jaytaylor.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null}},"created_at":"2015-03-25T18:51:56.000Z","updated_at":"2024-01-29T07:27:00.000Z","dependencies_parsed_at":"2022-07-24T16:17:23.247Z","dependency_job_id":null,"html_url":"https://github.com/jaytaylor/sql-layer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jaytaylor/sql-layer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaytaylor%2Fsql-layer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaytaylor%2Fsql-layer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaytaylor%2Fsql-layer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaytaylor%2Fsql-layer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jaytaylor","download_url":"https://codeload.github.com/jaytaylor/sql-layer/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaytaylor%2Fsql-layer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278820606,"owners_count":26051766,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-30T20:00:58.419Z","updated_at":"2025-10-07T17:59:09.846Z","avatar_url":"https://github.com/jaytaylor.png","language":"Java","funding_links":[],"categories":["Layers"],"sub_categories":[],"readme":"# FoundationDB SQL Layer\n\n## Overview\n\nThe FoundationDB SQL layer is a full SQL implementation that builds on\n[FoundationDB’s core features](https://foundationdb.com/features). It gets\nthe same high performance, multi-node scalability, fault-tolerance, and\ntrue multi-key ACID transactions while also providing new capabilities,\nincluding a sophisticated SQL environment and direct object access.\n\nIt was written from the ground up in Java and utilizes the\n[FoundationDB SQL Parser](https://github.com/FoundationDB/sql-parser).\n\nCheck out https://foundationdb.com/layers/sql for the full documentation.\n\n## Prerequisites\n\nThe FoundationDB SQL Layer requires Java 7 Runtime Environment and FoundationDB.\n\n### JRE\n\nThe FoundationDB SQL Layer requires the Java 7 Runtime Environment (JRE). Both\nOpenJDK JRE and the official Oracle JRE are supported.\n\nSee the [Oracle Java SE Downloads](http://www.oracle.com/technetwork/java/javase/downloads/index.html)\npage for installation details.\n\n\n### FoundationDB\n\nTo install FoundationDB, follow the official [Getting Started](https://foundationdb.com/documentation/getting-started.html)\nguides, being sure to check that the cluster is up and running (covered\nin *Testing your FoundationDB installation*).\n\n\n## Installing the SQL Layer\n\nThe SQL Layer can be installed from system packages (appropriate for most\npeople) or directly from source (intended for developers).\n\n### a. Packages\n\nOfficial packages for Windows, OS X, Ubuntu and CentOS/RedHat are available.\nSee the [installation section](https://foundationdb.com/layers/sql/documentation/GettingStarted/index.html)\nfor more details.\n\nA single instance of the SQL Layer is installed by default and is appropriate\nfor local development. Consult the documentation for recommended multi-node\nconfigurations.\n\n### b. Source\n\nNote: This section is intended *only* for developers.\n\nTo build the SQL Layer from source code several steps need to be taken in advance. \n* Have the [FoundationDB key-value store](https://foundationdb.com/get) installed and running.\n* Install Java Development Kit (JDK) version 7, either [OpenJDK](http://openjdk.java.net) \nor [Oracle JDK](http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html).\n* Set the environment variable JAVA_HOME to the directory in which the JDK is installed.\n* Install [Maven](http://maven.apache.org) version 3 to build the package.\n* Install [Protobuf](https://code.google.com/p/protobuf/wiki/Download?tm=2) version 2.5.0.\n  Installation instructions  are in their README.txt, it may require installation \n  of gpp. The Maven POM.xml file for building the SQL Layer\n  assumes this directory is present in the parent directory of the SQL Layer. \n* Clone and build the [FoundationDB SQL Parser](https://github.com/FoundationDB/sql-parser) \n* Clone and build the [FoundationDB JDBC Driver](https://github.com/FoundationDB/sql-layer-adapter-jdbc) \n\nNot a prerequisite but recommended, you can install the \n[SQL Layer Client Tools](https://github.com/FoundationDB/sql-layer-client-tools) to \ninteract with the SQL layer when it runs.\n\nAfter installing the listed prerequisites, you can clone the project using git, and build the SQL Layer.\n\nMove into the directory:\n\n    $ cd sql-layer\n\nUse Maven to build the project:\n\n    $ mvn install\n\nAll unit and integration tests will be run by default, which could be lengthy.\nTest execution can be avoided with the `skipTests` option:\n\n    $ mvn install -DskipTests=true\n\nAn executable jar, and required dependencies, will be the `target/` directory\nonce packaging is complete.\n\nThe server can then be started with the `fdbsqllayer` script. The `-f` flag\nwill run it in the foreground:\n\n    $ ./bin/fdbsqllayer -f\n\nOr for Windows users:\n\n    $ ./bin/fdbsqllayer.cmd -f\n\n\nA handful of informational messages will print and then the server will state it is ready:\n\n    2013-03-22 15:36:29,561 [main] INFO  ServiceManager - FoundationDB SQL Layer ready.\n\nWhen installing from source, you'll also want the\n[SQL Layer Client Tools](https://github.com/FoundationDB/sql-layer-client-tools).\n\n\n## 5. Testing Your SQL Layer Installation\n\nThe SQL Layer can then be accessed using the SQL client on port `15432`:\n\n    $ fdbsqlcli -c 'SELECT VERSION();'\n            _SQL_COL_1         \n    --------------------------\n     FoundationDB x.y.z +hash \n    (1 row)\n\nAnd using a RESTful API on port `8091`:\n\n    $ curl http://localhost:8091/v1/version\n    [\n    {\"server_name\":\"FoundationDB SQL Layer\",\"server_version\":\"x.y.z+hash\"}\n    ]\n\n## Contact\n\n* GitHub: http://github.com/FoundationDB/sql-layer\n* Community: https://foundationdb.com/community\n* IRC: #FoundationDB on irc.freenode.net\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaytaylor%2Fsql-layer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjaytaylor%2Fsql-layer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaytaylor%2Fsql-layer/lists"}