Skip to content

Latest commit

 

History

History
85 lines (69 loc) · 2.79 KB

GETTING-STARTED.md

File metadata and controls

85 lines (69 loc) · 2.79 KB
Raw

Splice Machine Developer Getting Started Guide

Links (internal sites, online tools, etc):

Primary GitHub project

This is helpful for Github interactions, saves typing username and password repeatedly. https://help.github.com/articles/generating-ssh-keys/

Sample gitconfig file

  • this text should be placed in ~/.gitconfig
[color]
    ui = auto
    status = auto
    branch = auto
[user]
    name = <FIRST_NAME LAST_NAME> (ex. Aaron Molitor)
    email = <EMAIL ADDRESS> (ex. amolitor@splicemachine.com)
[credential "https://github.com"]
    username = <GITHUB USERNAME> (ex. ammolitor)
[push]
    default = simple

Development Environment setup

Development/Build tools (Java, maven, etc.):

Note: JDK 1.8 is required for the master branch.

Instructions to compile protobufs

  1. Download the proper version of protocol buffers
    wget https://github.com/google/protobuf/releases/download/v2.5.0/protobuf-2.5.0.tar.bz2
  2. Untar the tar.bz2 file
    tar xfvj protobuf-2.5.0.tar.bz2
  3. Configure the protobuf.
    cd protobuf-2.5.0
    On Linux:
    ./configure
    On OS X/macOS:
    ./configure CC=clang CXX=clang++ CXXFLAGS='-std=c++11 -stdlib=libc++ -O3 -g' LDFLAGS='-stdlib=libc++' LIBS="-lc++ -lc++abi"
  4. Build the source
    make -j4
  5. Install the compiled binaries
    sudo make install

Helpful Environment Variables, etc. (example assumes Mac OS X developer machine)

# java
export J6_HOME="`/usr/libexec/java_home -v 1.6`"
export J7_HOME="`/usr/libexec/java_home -v 1.7`"
export J8_HOME="`/usr/libexec/java_home -v 1.8`"
export JAVA_HOME=${J8_HOME}
# maven
export M2_HOME="/opt/maven/apache-maven-3.3.9"
export MAVEN_OPTS="-Xmx4g -Djava.awt.headless=true -XX:ReservedCodeCacheSize=512m"
export M2=${M2_HOME}/bin
export PATH="${M2}:${PATH}"

IDE Setup

IntelliJ

  • import the maven project from the top level pom.xml

Eclipse

  • coming soon

Quick start

For those of you who want a quick start using the defaults, from the top-level:

./start-splice-cluster

This will compile everything and start the database.

Then to connect to the database:

./sqlshell.sh