Oxide

Motivation

The purpose of this project is to create a development platform for small to medium software projects and proof of concept software projects. The system will offer:

• Rust-inspired language syntax
• integrated dataframes with SQL-like grammar for queries
• integrated REST webservices
• integrated testing framework

Oxide is the spiritual successor to Lollypop, a multi-paradigm language also featuring integrated dataframes with SQL-like grammar for queries, but built for the JVM and developed in the Scala programming language.

Project Status

• The REPL is now available, and allows you to issue commands directly to the server.
• The database server is also now available and supports basic CRUD operations via REST for:
  • creating tables
  • dropping tables
  • insert/overwrite a row by offset
  • retrieve a row by offset
  • delete a row by offset
  • remote procedure calls

Development

Build the Oxide REPL and Server

cargo build --release

You'll find the executables in ./target/release/:

• oxide_repl is the Oxide REST client / REPL
• oxide_server is the Oxide REST Server

Run the tests

To run the tests (~ 130 tests at the time of writing):

cargo test

Getting Started

REPL

The Oxide REPL is now available, and with it, you can issue commands directly to the server. Oxide can evaluate basic expressions:

$ oxide
Welcome to Oxide REPL. Enter "q!" to quit.

oxide.public[0]> 5 + 9
[0] i64 in 17.0 millis
14

oxide.public[1]> (2 * 7) + 12
[1] i64 in 12.9 millis
26

Use the range operator (..) to creates slices (array-like structures):

oxide.public[2]> 1..7
[2] Array in 8.0 millis
[1,2,3,4,5,6]

Use the factorial operator (¡):

oxide.public[3]> 5¡
[3] f64 in 5.3 millis
120.0

Use the exponent operators (², ³, .., ⁹):

oxide.public[4]> 5²
[4] i64 in 5.5 millis
25

oxide.public[5]> 7³
[5] i64 in 6.1 millis
343

Use SQL-like updates and queries to create and manage data collections:

Welcome to Oxide REPL. Enter "q!" to quit.

oxide.public[0]> drop table ns("ldaniels.securities.stocks")
[0] Boolean in 9.6 millis
true

oxide.public[1]> create table ns("ldaniels.securities.stocks") (
    symbol: String(8),
    exchange: String(8),
    last_sale: f64
)
[1] Boolean in 9.5 millis
true

oxide.public[2]> into ns("ldaniels.securities.stocks")
                from { symbol: "ABC", exchange: "AMEX", last_sale: 12.49 }
[2] RowID in 15.2 millis
1

oxide.public[3]> into ns("ldaniels.securities.stocks")
                from { symbol: "BOOM", exchange: "NYSE", last_sale: 56.88 }
[3] RowID in 13.8 millis
1

oxide.public[4]> into ns("ldaniels.securities.stocks")
                from { symbol: "JET", exchange: "NASDAQ", last_sale: 32.12 }
[4] RowID in 11.8 millis
1

oxide.public[5]> from ns("ldaniels.securities.stocks")
[5] Table ~ 3 row(s) in 10.1 millis
|-------------------------------|
| symbol | exchange | last_sale |
|-------------------------------|
| ABC    | AMEX     | 12.49     |
| BOOM   | NYSE     | 56.88     |
| JET    | NASDAQ   | 32.12     |
|-------------------------------|

API/REST

Create a table

The following command will create a new table in the a.b.stocks namespace:

curl -X POST \
     -H "Content-Type: application/json" \
     -d '{
      "columns": [{
          "name": "symbol",
          "column_type": "String(4)",
          "default_value": null
        }, {
          "name": "exchange",
          "column_type": "String(4)",
          "default_value": null
        }, {
          "name": "lastSale",
          "column_type": "f64",
          "default_value": null
        }],
      "indices": [],
      "partitions": []
    }' \
    http://0.0.0.0:8080/a/b/stocks

Drop a table

The following command will delete the existing table in the a.b.stocks namespace:

curl -X DELETE http://0.0.0.0:8080/a/b/stocks

server response:

1

Insert/overwrite a row by offset

In this example we insert/overwrite a row into a new or existing table in the a.b.stocks namespace:

curl -X POST \
     -H "Content-Type: application/json" \
     -d '{
      "columns": [{
          "name": "symbol",
          "value": "ABC"
        }, {
          "name": "exchange",
          "value": "NYSE"
        }, {
          "name": "lastSale",
          "value": 56.17
        }],
      "indices": [],
      "partitions": []
    }' \
    http://0.0.0.0:8080/a/b/stocks/100

server response:

1

Retrieve a row by offset

The following command will retrieve the content at offset 100 from the a.b.stocks table:

curl -X GET http://0.0.0.0:8080/a/b/stocks/100

server response:

{
  "id": 100,
  "columns": [{
      "name": "symbol",
      "value": "ABC"
    }, {
      "name": "exchange",
      "value": "NYSE"
    }, {
      "name": "lastSale",
      "value": 56.17
    }]
}

Delete a row by offset

The following command will delete the existing table in the a.b.stocks namespace:

curl -X DELETE http://0.0.0.0:8080/a/b/stocks/100

server response:

1

Remote Procedure Calls

Remote Procedure Call (RPC) is a feature that allows Oxide to evaluate expressions across remote peers.

curl -X POST \
     -H "Content-Type: application/json" \
     -d '{
          "code": "5 + 5"
         }' \
     http://0.0.0.0:8080/rpc

server response:

10.0