Document not found (404)
+This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/api/query/graphql.html b/api/query/graphql.html
new file mode 100644
index 0000000..d5c9e02
--- /dev/null
+++ b/api/query/graphql.html
@@ -0,0 +1,245 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ HTTP API
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/api/query/index.html b/api/query/index.html
new file mode 100644
index 0000000..840f91c
--- /dev/null
+++ b/api/query/index.html
@@ -0,0 +1,224 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ GraphQL
+To query tables through GraphQL, send the query through POST request to
+/api/graphql endpoint.
GraphQL query frontend supports the same set of operators supported by REST +query frontend. Here how is you can apply various operators in a query:
+{
+ table_name(
+ filter: {
+ col1: false
+ col2: { gteq: 4, lt: 1000 }
+ }
+ sort: [
+ { field: "col2", order: "desc" }
+ { field: "col3" }
+ ]
+ limit: 100
+ ) {
+ col1
+ col2
+ col3
+ }
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/api/query/kv.html b/api/query/kv.html
new file mode 100644
index 0000000..73b9d47
--- /dev/null
+++ b/api/query/kv.html
@@ -0,0 +1,230 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Query frontends
+ROAPI exposes a diverse set of interfaces through the HTTP protocol.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/api/query/rest.html b/api/query/rest.html
new file mode 100644
index 0000000..e76f51e
--- /dev/null
+++ b/api/query/rest.html
@@ -0,0 +1,238 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Key value lookup
+Query key value stores through REST API by sending GET requests to
+/api/kv/{kv_name}/{key}.
For example, the kvstore defined in the sample +config can be queried like below:
+$ curl -v localhost:8080/api/kv/spacex_launch_name/600f9a8d8f798e2a4d5f979e
+Starlink-21 (v1.0)%
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/api/query/sql.html b/api/query/sql.html
new file mode 100644
index 0000000..3d6b8ed
--- /dev/null
+++ b/api/query/sql.html
@@ -0,0 +1,231 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ REST
+Query tables through REST API by sending GET requests to
+/api/tables/{table_name}. Query operators are specified as query params.
REST query frontend currently supports the following query operators:
+-
+
- columns +
- sort +
- limit +
- filter +
To sort column col1 in ascending order and col2 in descending order, set
+query param to: sort=col1,-col2.
To find all rows with col1 equal to string 'foo', set query param to:
+filter[col1]='foo'. You can also do basic comparisons with filters, for
+example predicate 0 <= col2 < 5 can be expressed as
+filter[col2]gte=0&filter[col2]lt=5.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/api/response.html b/api/response.html
new file mode 100644
index 0000000..2c24fbf
--- /dev/null
+++ b/api/response.html
@@ -0,0 +1,232 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SQL
+To query tables using a subset of standard SQL, send the query payload through
+POST request to /api/sql endpoint. This is the only query interface that
+supports table joins.
SQL query frontend is the more flexible and powerful compared to +REST and GraphQL. It is the only query frontend +that supports table joins.
+SQL frontend supports [""] operator for accessing struct fields and array
+element. For example struct_col["key1"]["key2"] or array_col[0].
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/api/schema.html b/api/schema.html
new file mode 100644
index 0000000..270a607
--- /dev/null
+++ b/api/schema.html
@@ -0,0 +1,229 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Response serialization
+By default, ROAPI encodes responses in JSON format, but you can request
+different encodings by specifying the ACCEPT header:
curl -X POST \
+ -H 'ACCEPT: application/vnd.apache.arrow.stream' \
+ -d "SELECT launch_library_id FROM spacex_launches WHERE launch_library_id IS NOT NULL" \
+ localhost:8080/api/sql
+ROAPI currently supports the following serialization formats:
+-
+
application/json
+application/csv
+application/vnd.apache.arrow.file
+application/vnd.apache.arrow.stream
+application/parquet
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ayu-highlight.css b/ayu-highlight.css
new file mode 100644
index 0000000..32c9432
--- /dev/null
+++ b/ayu-highlight.css
@@ -0,0 +1,78 @@
+/*
+Based off of the Ayu theme
+Original by Dempfi (https://github.com/dempfi/ayu)
+*/
+
+.hljs {
+ display: block;
+ overflow-x: auto;
+ background: #191f26;
+ color: #e6e1cf;
+}
+
+.hljs-comment,
+.hljs-quote {
+ color: #5c6773;
+ font-style: italic;
+}
+
+.hljs-variable,
+.hljs-template-variable,
+.hljs-attribute,
+.hljs-attr,
+.hljs-regexp,
+.hljs-link,
+.hljs-selector-id,
+.hljs-selector-class {
+ color: #ff7733;
+}
+
+.hljs-number,
+.hljs-meta,
+.hljs-builtin-name,
+.hljs-literal,
+.hljs-type,
+.hljs-params {
+ color: #ffee99;
+}
+
+.hljs-string,
+.hljs-bullet {
+ color: #b8cc52;
+}
+
+.hljs-title,
+.hljs-built_in,
+.hljs-section {
+ color: #ffb454;
+}
+
+.hljs-keyword,
+.hljs-selector-tag,
+.hljs-symbol {
+ color: #ff7733;
+}
+
+.hljs-name {
+ color: #36a3d9;
+}
+
+.hljs-tag {
+ color: #00568d;
+}
+
+.hljs-emphasis {
+ font-style: italic;
+}
+
+.hljs-strong {
+ font-weight: bold;
+}
+
+.hljs-addition {
+ color: #91b362;
+}
+
+.hljs-deletion {
+ color: #d96c75;
+}
diff --git a/book.js b/book.js
new file mode 100644
index 0000000..178f1e9
--- /dev/null
+++ b/book.js
@@ -0,0 +1,690 @@
+"use strict";
+
+// Fix back button cache problem
+window.onunload = function () { };
+
+// Global variable, shared between modules
+function playground_text(playground, hidden = true) {
+ let code_block = playground.querySelector("code");
+
+ if (window.ace && code_block.classList.contains("editable")) {
+ let editor = window.ace.edit(code_block);
+ return editor.getValue();
+ } else if (hidden) {
+ return code_block.textContent;
+ } else {
+ return code_block.innerText;
+ }
+}
+
+(function codeSnippets() {
+ function fetch_with_timeout(url, options, timeout = 6000) {
+ return Promise.race([
+ fetch(url, options),
+ new Promise((_, reject) => setTimeout(() => reject(new Error('timeout')), timeout))
+ ]);
+ }
+
+ var playgrounds = Array.from(document.querySelectorAll(".playground"));
+ if (playgrounds.length > 0) {
+ fetch_with_timeout("https://play.rust-lang.org/meta/crates", {
+ headers: {
+ 'Content-Type': "application/json",
+ },
+ method: 'POST',
+ mode: 'cors',
+ })
+ .then(response => response.json())
+ .then(response => {
+ // get list of crates available in the rust playground
+ let playground_crates = response.crates.map(item => item["id"]);
+ playgrounds.forEach(block => handle_crate_list_update(block, playground_crates));
+ });
+ }
+
+ function handle_crate_list_update(playground_block, playground_crates) {
+ // update the play buttons after receiving the response
+ update_play_button(playground_block, playground_crates);
+
+ // and install on change listener to dynamically update ACE editors
+ if (window.ace) {
+ let code_block = playground_block.querySelector("code");
+ if (code_block.classList.contains("editable")) {
+ let editor = window.ace.edit(code_block);
+ editor.addEventListener("change", function (e) {
+ update_play_button(playground_block, playground_crates);
+ });
+ // add Ctrl-Enter command to execute rust code
+ editor.commands.addCommand({
+ name: "run",
+ bindKey: {
+ win: "Ctrl-Enter",
+ mac: "Ctrl-Enter"
+ },
+ exec: _editor => run_rust_code(playground_block)
+ });
+ }
+ }
+ }
+
+ // updates the visibility of play button based on `no_run` class and
+ // used crates vs ones available on https://play.rust-lang.org
+ function update_play_button(pre_block, playground_crates) {
+ var play_button = pre_block.querySelector(".play-button");
+
+ // skip if code is `no_run`
+ if (pre_block.querySelector('code').classList.contains("no_run")) {
+ play_button.classList.add("hidden");
+ return;
+ }
+
+ // get list of `extern crate`'s from snippet
+ var txt = playground_text(pre_block);
+ var re = /extern\s+crate\s+([a-zA-Z_0-9]+)\s*;/g;
+ var snippet_crates = [];
+ var item;
+ while (item = re.exec(txt)) {
+ snippet_crates.push(item[1]);
+ }
+
+ // check if all used crates are available on play.rust-lang.org
+ var all_available = snippet_crates.every(function (elem) {
+ return playground_crates.indexOf(elem) > -1;
+ });
+
+ if (all_available) {
+ play_button.classList.remove("hidden");
+ } else {
+ play_button.classList.add("hidden");
+ }
+ }
+
+ function run_rust_code(code_block) {
+ var result_block = code_block.querySelector(".result");
+ if (!result_block) {
+ result_block = document.createElement('code');
+ result_block.className = 'result hljs language-bash';
+
+ code_block.append(result_block);
+ }
+
+ let text = playground_text(code_block);
+ let classes = code_block.querySelector('code').classList;
+ let edition = "2015";
+ if(classes.contains("edition2018")) {
+ edition = "2018";
+ } else if(classes.contains("edition2021")) {
+ edition = "2021";
+ }
+ var params = {
+ version: "stable",
+ optimize: "0",
+ code: text,
+ edition: edition
+ };
+
+ if (text.indexOf("#![feature") !== -1) {
+ params.version = "nightly";
+ }
+
+ result_block.innerText = "Running...";
+
+ fetch_with_timeout("https://play.rust-lang.org/evaluate.json", {
+ headers: {
+ 'Content-Type': "application/json",
+ },
+ method: 'POST',
+ mode: 'cors',
+ body: JSON.stringify(params)
+ })
+ .then(response => response.json())
+ .then(response => {
+ if (response.result.trim() === '') {
+ result_block.innerText = "No output";
+ result_block.classList.add("result-no-output");
+ } else {
+ result_block.innerText = response.result;
+ result_block.classList.remove("result-no-output");
+ }
+ })
+ .catch(error => result_block.innerText = "Playground Communication: " + error.message);
+ }
+
+ // Syntax highlighting Configuration
+ hljs.configure({
+ tabReplace: ' ', // 4 spaces
+ languages: [], // Languages used for auto-detection
+ });
+
+ let code_nodes = Array
+ .from(document.querySelectorAll('code'))
+ // Don't highlight `inline code` blocks in headers.
+ .filter(function (node) {return !node.parentElement.classList.contains("header"); });
+
+ if (window.ace) {
+ // language-rust class needs to be removed for editable
+ // blocks or highlightjs will capture events
+ code_nodes
+ .filter(function (node) {return node.classList.contains("editable"); })
+ .forEach(function (block) { block.classList.remove('language-rust'); });
+
+ code_nodes
+ .filter(function (node) {return !node.classList.contains("editable"); })
+ .forEach(function (block) { hljs.highlightBlock(block); });
+ } else {
+ code_nodes.forEach(function (block) { hljs.highlightBlock(block); });
+ }
+
+ // Adding the hljs class gives code blocks the color css
+ // even if highlighting doesn't apply
+ code_nodes.forEach(function (block) { block.classList.add('hljs'); });
+
+ Array.from(document.querySelectorAll("code.hljs")).forEach(function (block) {
+
+ var lines = Array.from(block.querySelectorAll('.boring'));
+ // If no lines were hidden, return
+ if (!lines.length) { return; }
+ block.classList.add("hide-boring");
+
+ var buttons = document.createElement('div');
+ buttons.className = 'buttons';
+ buttons.innerHTML = "";
+
+ // add expand button
+ var pre_block = block.parentNode;
+ pre_block.insertBefore(buttons, pre_block.firstChild);
+
+ pre_block.querySelector('.buttons').addEventListener('click', function (e) {
+ if (e.target.classList.contains('fa-eye')) {
+ e.target.classList.remove('fa-eye');
+ e.target.classList.add('fa-eye-slash');
+ e.target.title = 'Hide lines';
+ e.target.setAttribute('aria-label', e.target.title);
+
+ block.classList.remove('hide-boring');
+ } else if (e.target.classList.contains('fa-eye-slash')) {
+ e.target.classList.remove('fa-eye-slash');
+ e.target.classList.add('fa-eye');
+ e.target.title = 'Show hidden lines';
+ e.target.setAttribute('aria-label', e.target.title);
+
+ block.classList.add('hide-boring');
+ }
+ });
+ });
+
+ if (window.playground_copyable) {
+ Array.from(document.querySelectorAll('pre code')).forEach(function (block) {
+ var pre_block = block.parentNode;
+ if (!pre_block.classList.contains('playground')) {
+ var buttons = pre_block.querySelector(".buttons");
+ if (!buttons) {
+ buttons = document.createElement('div');
+ buttons.className = 'buttons';
+ pre_block.insertBefore(buttons, pre_block.firstChild);
+ }
+
+ var clipButton = document.createElement('button');
+ clipButton.className = 'clip-button';
+ clipButton.title = 'Copy to clipboard';
+ clipButton.setAttribute('aria-label', clipButton.title);
+ clipButton.innerHTML = '';
+
+ buttons.insertBefore(clipButton, buttons.firstChild);
+ }
+ });
+ }
+
+ // Process playground code blocks
+ Array.from(document.querySelectorAll(".playground")).forEach(function (pre_block) {
+ // Add play button
+ var buttons = pre_block.querySelector(".buttons");
+ if (!buttons) {
+ buttons = document.createElement('div');
+ buttons.className = 'buttons';
+ pre_block.insertBefore(buttons, pre_block.firstChild);
+ }
+
+ var runCodeButton = document.createElement('button');
+ runCodeButton.className = 'fa fa-play play-button';
+ runCodeButton.hidden = true;
+ runCodeButton.title = 'Run this code';
+ runCodeButton.setAttribute('aria-label', runCodeButton.title);
+
+ buttons.insertBefore(runCodeButton, buttons.firstChild);
+ runCodeButton.addEventListener('click', function (e) {
+ run_rust_code(pre_block);
+ });
+
+ if (window.playground_copyable) {
+ var copyCodeClipboardButton = document.createElement('button');
+ copyCodeClipboardButton.className = 'clip-button';
+ copyCodeClipboardButton.innerHTML = '';
+ copyCodeClipboardButton.title = 'Copy to clipboard';
+ copyCodeClipboardButton.setAttribute('aria-label', copyCodeClipboardButton.title);
+
+ buttons.insertBefore(copyCodeClipboardButton, buttons.firstChild);
+ }
+
+ let code_block = pre_block.querySelector("code");
+ if (window.ace && code_block.classList.contains("editable")) {
+ var undoChangesButton = document.createElement('button');
+ undoChangesButton.className = 'fa fa-history reset-button';
+ undoChangesButton.title = 'Undo changes';
+ undoChangesButton.setAttribute('aria-label', undoChangesButton.title);
+
+ buttons.insertBefore(undoChangesButton, buttons.firstChild);
+
+ undoChangesButton.addEventListener('click', function () {
+ let editor = window.ace.edit(code_block);
+ editor.setValue(editor.originalCode);
+ editor.clearSelection();
+ });
+ }
+ });
+})();
+
+(function themes() {
+ var html = document.querySelector('html');
+ var themeToggleButton = document.getElementById('theme-toggle');
+ var themePopup = document.getElementById('theme-list');
+ var themeColorMetaTag = document.querySelector('meta[name="theme-color"]');
+ var themeIds = [];
+ themePopup.querySelectorAll('button.theme').forEach(function (el) {
+ themeIds.push(el.id);
+ });
+ var stylesheets = {
+ ayuHighlight: document.querySelector("[href$='ayu-highlight.css']"),
+ tomorrowNight: document.querySelector("[href$='tomorrow-night.css']"),
+ highlight: document.querySelector("[href$='highlight.css']"),
+ };
+
+ function showThemes() {
+ themePopup.style.display = 'block';
+ themeToggleButton.setAttribute('aria-expanded', true);
+ themePopup.querySelector("button#" + get_theme()).focus();
+ }
+
+ function updateThemeSelected() {
+ themePopup.querySelectorAll('.theme-selected').forEach(function (el) {
+ el.classList.remove('theme-selected');
+ });
+ themePopup.querySelector("button#" + get_theme()).classList.add('theme-selected');
+ }
+
+ function hideThemes() {
+ themePopup.style.display = 'none';
+ themeToggleButton.setAttribute('aria-expanded', false);
+ themeToggleButton.focus();
+ }
+
+ function get_theme() {
+ var theme;
+ try { theme = localStorage.getItem('mdbook-theme'); } catch (e) { }
+ if (theme === null || theme === undefined || !themeIds.includes(theme)) {
+ return default_theme;
+ } else {
+ return theme;
+ }
+ }
+
+ function set_theme(theme, store = true) {
+ let ace_theme;
+
+ if (theme == 'coal' || theme == 'navy') {
+ stylesheets.ayuHighlight.disabled = true;
+ stylesheets.tomorrowNight.disabled = false;
+ stylesheets.highlight.disabled = true;
+
+ ace_theme = "ace/theme/tomorrow_night";
+ } else if (theme == 'ayu') {
+ stylesheets.ayuHighlight.disabled = false;
+ stylesheets.tomorrowNight.disabled = true;
+ stylesheets.highlight.disabled = true;
+ ace_theme = "ace/theme/tomorrow_night";
+ } else {
+ stylesheets.ayuHighlight.disabled = true;
+ stylesheets.tomorrowNight.disabled = true;
+ stylesheets.highlight.disabled = false;
+ ace_theme = "ace/theme/dawn";
+ }
+
+ setTimeout(function () {
+ themeColorMetaTag.content = getComputedStyle(document.documentElement).backgroundColor;
+ }, 1);
+
+ if (window.ace && window.editors) {
+ window.editors.forEach(function (editor) {
+ editor.setTheme(ace_theme);
+ });
+ }
+
+ var previousTheme = get_theme();
+
+ if (store) {
+ try { localStorage.setItem('mdbook-theme', theme); } catch (e) { }
+ }
+
+ html.classList.remove(previousTheme);
+ html.classList.add(theme);
+ updateThemeSelected();
+ }
+
+ // Set theme
+ var theme = get_theme();
+
+ set_theme(theme, false);
+
+ themeToggleButton.addEventListener('click', function () {
+ if (themePopup.style.display === 'block') {
+ hideThemes();
+ } else {
+ showThemes();
+ }
+ });
+
+ themePopup.addEventListener('click', function (e) {
+ var theme;
+ if (e.target.className === "theme") {
+ theme = e.target.id;
+ } else if (e.target.parentElement.className === "theme") {
+ theme = e.target.parentElement.id;
+ } else {
+ return;
+ }
+ set_theme(theme);
+ });
+
+ themePopup.addEventListener('focusout', function(e) {
+ // e.relatedTarget is null in Safari and Firefox on macOS (see workaround below)
+ if (!!e.relatedTarget && !themeToggleButton.contains(e.relatedTarget) && !themePopup.contains(e.relatedTarget)) {
+ hideThemes();
+ }
+ });
+
+ // Should not be needed, but it works around an issue on macOS & iOS: https://github.com/rust-lang/mdBook/issues/628
+ document.addEventListener('click', function(e) {
+ if (themePopup.style.display === 'block' && !themeToggleButton.contains(e.target) && !themePopup.contains(e.target)) {
+ hideThemes();
+ }
+ });
+
+ document.addEventListener('keydown', function (e) {
+ if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) { return; }
+ if (!themePopup.contains(e.target)) { return; }
+
+ switch (e.key) {
+ case 'Escape':
+ e.preventDefault();
+ hideThemes();
+ break;
+ case 'ArrowUp':
+ e.preventDefault();
+ var li = document.activeElement.parentElement;
+ if (li && li.previousElementSibling) {
+ li.previousElementSibling.querySelector('button').focus();
+ }
+ break;
+ case 'ArrowDown':
+ e.preventDefault();
+ var li = document.activeElement.parentElement;
+ if (li && li.nextElementSibling) {
+ li.nextElementSibling.querySelector('button').focus();
+ }
+ break;
+ case 'Home':
+ e.preventDefault();
+ themePopup.querySelector('li:first-child button').focus();
+ break;
+ case 'End':
+ e.preventDefault();
+ themePopup.querySelector('li:last-child button').focus();
+ break;
+ }
+ });
+})();
+
+(function sidebar() {
+ var body = document.querySelector("body");
+ var sidebar = document.getElementById("sidebar");
+ var sidebarLinks = document.querySelectorAll('#sidebar a');
+ var sidebarToggleButton = document.getElementById("sidebar-toggle");
+ var sidebarResizeHandle = document.getElementById("sidebar-resize-handle");
+ var firstContact = null;
+
+ function showSidebar() {
+ body.classList.remove('sidebar-hidden')
+ body.classList.add('sidebar-visible');
+ Array.from(sidebarLinks).forEach(function (link) {
+ link.setAttribute('tabIndex', 0);
+ });
+ sidebarToggleButton.setAttribute('aria-expanded', true);
+ sidebar.setAttribute('aria-hidden', false);
+ try { localStorage.setItem('mdbook-sidebar', 'visible'); } catch (e) { }
+ }
+
+ function hideSidebar() {
+ body.classList.remove('sidebar-visible')
+ body.classList.add('sidebar-hidden');
+ Array.from(sidebarLinks).forEach(function (link) {
+ link.setAttribute('tabIndex', -1);
+ });
+ sidebarToggleButton.setAttribute('aria-expanded', false);
+ sidebar.setAttribute('aria-hidden', true);
+ try { localStorage.setItem('mdbook-sidebar', 'hidden'); } catch (e) { }
+ }
+
+ // Toggle sidebar
+ sidebarToggleButton.addEventListener('click', function sidebarToggle() {
+ if (body.classList.contains("sidebar-hidden")) {
+ var current_width = parseInt(
+ document.documentElement.style.getPropertyValue('--sidebar-width'), 10);
+ if (current_width < 150) {
+ document.documentElement.style.setProperty('--sidebar-width', '150px');
+ }
+ showSidebar();
+ } else if (body.classList.contains("sidebar-visible")) {
+ hideSidebar();
+ } else {
+ if (getComputedStyle(sidebar)['transform'] === 'none') {
+ hideSidebar();
+ } else {
+ showSidebar();
+ }
+ }
+ });
+
+ sidebarResizeHandle.addEventListener('mousedown', initResize, false);
+
+ function initResize(e) {
+ window.addEventListener('mousemove', resize, false);
+ window.addEventListener('mouseup', stopResize, false);
+ body.classList.add('sidebar-resizing');
+ }
+ function resize(e) {
+ var pos = (e.clientX - sidebar.offsetLeft);
+ if (pos < 20) {
+ hideSidebar();
+ } else {
+ if (body.classList.contains("sidebar-hidden")) {
+ showSidebar();
+ }
+ pos = Math.min(pos, window.innerWidth - 100);
+ document.documentElement.style.setProperty('--sidebar-width', pos + 'px');
+ }
+ }
+ //on mouseup remove windows functions mousemove & mouseup
+ function stopResize(e) {
+ body.classList.remove('sidebar-resizing');
+ window.removeEventListener('mousemove', resize, false);
+ window.removeEventListener('mouseup', stopResize, false);
+ }
+
+ document.addEventListener('touchstart', function (e) {
+ firstContact = {
+ x: e.touches[0].clientX,
+ time: Date.now()
+ };
+ }, { passive: true });
+
+ document.addEventListener('touchmove', function (e) {
+ if (!firstContact)
+ return;
+
+ var curX = e.touches[0].clientX;
+ var xDiff = curX - firstContact.x,
+ tDiff = Date.now() - firstContact.time;
+
+ if (tDiff < 250 && Math.abs(xDiff) >= 150) {
+ if (xDiff >= 0 && firstContact.x < Math.min(document.body.clientWidth * 0.25, 300))
+ showSidebar();
+ else if (xDiff < 0 && curX < 300)
+ hideSidebar();
+
+ firstContact = null;
+ }
+ }, { passive: true });
+})();
+
+(function chapterNavigation() {
+ document.addEventListener('keydown', function (e) {
+ if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) { return; }
+ if (window.search && window.search.hasFocus()) { return; }
+ var html = document.querySelector('html');
+
+ function next() {
+ var nextButton = document.querySelector('.nav-chapters.next');
+ if (nextButton) {
+ window.location.href = nextButton.href;
+ }
+ }
+ function prev() {
+ var previousButton = document.querySelector('.nav-chapters.previous');
+ if (previousButton) {
+ window.location.href = previousButton.href;
+ }
+ }
+ switch (e.key) {
+ case 'ArrowRight':
+ e.preventDefault();
+ if (html.dir == 'rtl') {
+ prev();
+ } else {
+ next();
+ }
+ break;
+ case 'ArrowLeft':
+ e.preventDefault();
+ if (html.dir == 'rtl') {
+ next();
+ } else {
+ prev();
+ }
+ break;
+ }
+ });
+})();
+
+(function clipboard() {
+ var clipButtons = document.querySelectorAll('.clip-button');
+
+ function hideTooltip(elem) {
+ elem.firstChild.innerText = "";
+ elem.className = 'clip-button';
+ }
+
+ function showTooltip(elem, msg) {
+ elem.firstChild.innerText = msg;
+ elem.className = 'clip-button tooltipped';
+ }
+
+ var clipboardSnippets = new ClipboardJS('.clip-button', {
+ text: function (trigger) {
+ hideTooltip(trigger);
+ let playground = trigger.closest("pre");
+ return playground_text(playground, false);
+ }
+ });
+
+ Array.from(clipButtons).forEach(function (clipButton) {
+ clipButton.addEventListener('mouseout', function (e) {
+ hideTooltip(e.currentTarget);
+ });
+ });
+
+ clipboardSnippets.on('success', function (e) {
+ e.clearSelection();
+ showTooltip(e.trigger, "Copied!");
+ });
+
+ clipboardSnippets.on('error', function (e) {
+ showTooltip(e.trigger, "Clipboard error!");
+ });
+})();
+
+(function scrollToTop () {
+ var menuTitle = document.querySelector('.menu-title');
+
+ menuTitle.addEventListener('click', function () {
+ document.scrollingElement.scrollTo({ top: 0, behavior: 'smooth' });
+ });
+})();
+
+(function controllMenu() {
+ var menu = document.getElementById('menu-bar');
+
+ (function controllPosition() {
+ var scrollTop = document.scrollingElement.scrollTop;
+ var prevScrollTop = scrollTop;
+ var minMenuY = -menu.clientHeight - 50;
+ // When the script loads, the page can be at any scroll (e.g. if you reforesh it).
+ menu.style.top = scrollTop + 'px';
+ // Same as parseInt(menu.style.top.slice(0, -2), but faster
+ var topCache = menu.style.top.slice(0, -2);
+ menu.classList.remove('sticky');
+ var stickyCache = false; // Same as menu.classList.contains('sticky'), but faster
+ document.addEventListener('scroll', function () {
+ scrollTop = Math.max(document.scrollingElement.scrollTop, 0);
+ // `null` means that it doesn't need to be updated
+ var nextSticky = null;
+ var nextTop = null;
+ var scrollDown = scrollTop > prevScrollTop;
+ var menuPosAbsoluteY = topCache - scrollTop;
+ if (scrollDown) {
+ nextSticky = false;
+ if (menuPosAbsoluteY > 0) {
+ nextTop = prevScrollTop;
+ }
+ } else {
+ if (menuPosAbsoluteY > 0) {
+ nextSticky = true;
+ } else if (menuPosAbsoluteY < minMenuY) {
+ nextTop = prevScrollTop + minMenuY;
+ }
+ }
+ if (nextSticky === true && stickyCache === false) {
+ menu.classList.add('sticky');
+ stickyCache = true;
+ } else if (nextSticky === false && stickyCache === true) {
+ menu.classList.remove('sticky');
+ stickyCache = false;
+ }
+ if (nextTop !== null) {
+ menu.style.top = nextTop + 'px';
+ topCache = nextTop;
+ }
+ prevScrollTop = scrollTop;
+ }, { passive: true });
+ })();
+ (function controllBorder() {
+ function updateBorder() {
+ if (menu.offsetTop === 0) {
+ menu.classList.remove('bordered');
+ } else {
+ menu.classList.add('bordered');
+ }
+ }
+ updateBorder();
+ document.addEventListener('scroll', updateBorder, { passive: true });
+ })();
+})();
diff --git a/book.toml b/book.toml
deleted file mode 100644
index b62e75b..0000000
--- a/book.toml
+++ /dev/null
@@ -1,14 +0,0 @@
-[book]
-authors = ["Qingping Hou"]
-language = "en"
-multilingual = false
-src = "src"
-title = "ROAPI Documentation"
-
-[output.html]
-git-repository-url = "https://github.com/roapi/docs"
-additional-css = ["open-in-gh.css"]
-
-[preprocessor.open-on-gh]
-command = "mdbook-open-on-gh"
-renderer = ["html"]
diff --git a/clipboard.min.js b/clipboard.min.js
new file mode 100644
index 0000000..02c549e
--- /dev/null
+++ b/clipboard.min.js
@@ -0,0 +1,7 @@
+/*!
+ * clipboard.js v2.0.4
+ * https://zenorocha.github.io/clipboard.js
+ *
+ * Licensed MIT © Zeno Rocha
+ */
+!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.ClipboardJS=e():t.ClipboardJS=e()}(this,function(){return function(n){var o={};function r(t){if(o[t])return o[t].exports;var e=o[t]={i:t,l:!1,exports:{}};return n[t].call(e.exports,e,e.exports,r),e.l=!0,e.exports}return r.m=n,r.c=o,r.d=function(t,e,n){r.o(t,e)||Object.defineProperty(t,e,{enumerable:!0,get:n})},r.r=function(t){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})},r.t=function(e,t){if(1&t&&(e=r(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)r.d(n,o,function(t){return e[t]}.bind(null,o));return n},r.n=function(t){var e=t&&t.__esModule?function(){return t.default}:function(){return t};return r.d(e,"a",e),e},r.o=function(t,e){return Object.prototype.hasOwnProperty.call(t,e)},r.p="",r(r.s=0)}([function(t,e,n){"use strict";var r="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(t){return typeof t}:function(t){return t&&"function"==typeof Symbol&&t.constructor===Symbol&&t!==Symbol.prototype?"symbol":typeof t},i=function(){function o(t,e){for(var n=0;n
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Schema
+Get schemas for all tables:
+curl localhost:8080/api/schema
+Get schema for a specific table by name:
+curl localhost:8080/api/schema/{TABLE_NAME}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/config/cli.html b/config/cli.html
new file mode 100644
index 0000000..c856c9e
--- /dev/null
+++ b/config/cli.html
@@ -0,0 +1,262 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Blob store
+ROAPI currently supports the following blob storages:
+-
+
- Filesystem +
- HTTP/HTTPS +
- S3 +
- GCS +
- Azure Storage +
Filesystem
+Filesystem store can be specified using file: or filesystem: schemes. In a
+Windows environment, the scheme is mandatory. On Unix systems, a uri without a
+scheme prefix is treated as filesystem backed data source by ROAPI.
For example, to serve a local parquet file test_data/blogs.parquet, you can
+just set the uri to the file path:
tables:
+ - name: "blogs"
+ uri: "test_data/blogs.parquet"
+Filesystem store supports loading partitioned tables. In other words, you can +split up the table into mulitple files and load all of them into a single table +by setting uri to the directory path. When loading a partitioned dataset, you +will need to manually specify table format since the uri will not contain table +format as a suffix:
+tables:
+ - name: "blogs"
+ uri: "test_data/blogs/"
+ option:
+ format: "parquet"
+HTTP/HTTPS
+ROAPI can build tables from datasets served through HTTP protocols. However, one +thing to keep in mind is HTTP store doesn't support partitioned datasets because +there is no native directory listing support in the HTTP protocol.
+To set custom headers for HTTP requests, you can use the headers io option:
tables:
+ - name: "TABLE_NAME"
+ uri: "http://bucket/TABLE/KEY.csv"
+ io_option:
+ headers:
+ 'Content-Type': 'application/json'
+ Authorization: 'Bearer TOKEN'
+S3
+ROAPI can build tables from datasets hosted in S3 buckets. Configuration is +similar to filesystem store:
+tables:
+ - name: "TABLE_NAME"
+ uri: "s3://BUCKET/TABLE/KEY"
+ option:
+ format: "csv"
+To configure S3 credentials, you can set the following environment variables:
+-
+
AWS_ENDPOINT_URL: The endpoint URL for your S3 provider
+AWS_REGION: The region where your S3 bucket is located
+AWS_SECRET_ACCESS_KEY: The secret access key from your S3 provider
+AWS_ACCESS_KEY_ID: The access key ID from your S3 provider
+
GCS
+ROAPI can build tables from datasets hosted in GCS buckets. Configuration is +similar to filesystem store:
+tables:
+ - name: "TABLE_NAME"
+ uri: "gs://BUCKET/TABLE/KEY"
+ option:
+ format: "csv"
+To configure GCS credentials, you can set the following +environment variables if you are using service accont:
+-
+
GOOGLE_SERVICE_ACCOUNT/GOOGLE_SERVICE_ACCOUNT_PATH: location of service account file
+GOOGLE_SERVICE_ACCOUNT_KEY: JSON serialized service account key
+GOOGLE_APPLICATION_CREDENTIALS: set by gcloud SDK
+- Google Compute Engine Service Account +
- GKE Workload Identity +
Azure Storage
+ROAPI can build tables from datasets hosted in Azure Storage. Configuration is +similar to filesystem store:
+tables:
+ - name: "TABLE_NAME"
+ uri: "az://BUCKET/TABLE/KEY"
+ option:
+ format: "csv"
+The supported url schemas are
+-
+
abfs[s]://<container>/<path>
+az://<container>/<path>
+adl://<container>/<path>
+azure://<container>/<path>
+
To configure Azure credentials, you can set the following +environment variables:
+-
+
AZURE_STORAGE_ACCOUNT_NAME
+AZURE_STORAGE_ACCOUNT_KEY
+AZURE_STORAGE_CLIENT_ID
+AZURE_STORAGE_TENANT_ID
+AZURE_STORAGE_SAS_KEY
+AZURE_STORAGE_TOKEN
+AZURE_MSI_ENDPOINT/AZURE_IDENTITY_ENDPOINT: Endpoint to request a imds managed identity token
+AZURE_OBJECT_ID: Object id for use with managed identity authentication
+AZURE_MSI_RESOURCE_ID: Msi resource id for use with managed identity authentication
+AZURE_FEDERATED_TOKEN_FILE: File containing token for Azure AD workload identity federation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/config/config-file.html b/config/config-file.html
new file mode 100644
index 0000000..f400912
--- /dev/null
+++ b/config/config-file.html
@@ -0,0 +1,292 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Command line argument
+You can configure ROAPI to load as many tables as you want by repeating the --table argument:
roapi --table 'table1_name=table1_uri' --table 'table2_name=table2_uri'
+You can use RUST_LOG environment variable to control the logging verbosity:
RUST_LOG=debug roapi ...
+Here is the output from roapi --help:
roapi 0.7.1
+QP Hou
+Create full-fledged APIs for static datasets without writing a single line of code.
+
+USAGE:
+ roapi [OPTIONS]
+
+OPTIONS:
+ -a, --addr-http <IP:PORT>
+ HTTP endpoint bind address
+
+ -c, --config <config>
+ config file path
+
+ -d, --disable-read-only
+ Start roapi in read write mode
+
+ -h, --help
+ Print help information
+
+ -p, --addr-postgres <IP:PORT>
+ Postgres endpoint bind address
+
+ -t, --table <[table_name=]uri[,option_key=option_value]>
+ Table sources to load. Table option can be provided as optional setting as part of the
+ table URI, for example: `blogs=s3://bucket/key,format=delta`. Set table uri to `stdin`
+ if you want to consume table data from stdin as part of a UNIX pipe. If no table_name is
+ provided, a table name will be derived from the filename in URI.
+
+ -V, --version
+ Print version information
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/config/databases.html b/config/databases.html
new file mode 100644
index 0000000..978e79c
--- /dev/null
+++ b/config/databases.html
@@ -0,0 +1,246 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ YAML config
+Tables
+You can configure multiple table sources using YAML config, which supports more +advanced format specific table options. For example:
+addr:
+ # binding address for TCP port that speaks HTTP protocol
+ http: 0.0.0.0:8080
+ # binding address for TCP port that speaks Postgres wire protocol
+ postgres: 0.0.0.0:5432
+tables:
+ - name: "blogs"
+ uri: "test_data/blogs.parquet"
+
+ - name: "ubuntu_ami"
+ uri: "test_data/ubuntu-ami.json"
+ option:
+ format: "json"
+ pointer: "/aaData"
+ array_encoded: true
+ schema:
+ columns:
+ - name: "zone"
+ data_type: "Utf8"
+ - name: "name"
+ data_type: "Utf8"
+ - name: "version"
+ data_type: "Utf8"
+ - name: "arch"
+ data_type: "Utf8"
+ - name: "instance_type"
+ data_type: "Utf8"
+ - name: "release"
+ data_type: "Utf8"
+ - name: "ami_id"
+ data_type: "Utf8"
+ - name: "aki_id"
+ data_type: "Utf8"
+
+ - name: "spacex_launches"
+ uri: "https://api.spacexdata.com/v4/launches"
+ option:
+ format: "json"
+
+ - name: "github_jobs"
+ uri: "https://web.archive.org/web/20210507025928if_/https://jobs.github.com/positions.json"
+Key value stores
+Table sources can be loaded into in-memory key value stores if you specify which two +columns to be used to load keys and values in the config:
+kvstores:
+ - name: "spacex_launch_name"
+ uri: "test_data/spacex_launches.json"
+ key: id
+ value: name
+The above config will create a keyvalue store named spacex_launch_name that allows you to lookup SpaceX launch names using launch ids.
DataFusion configuration
+You can override DataFusion configuration settings by specifying them in the datafusion section of your config file. This allows you to tune the query engine's behavior for your specific use case:
datafusion:
+ "execution.collect_statistics": "true"
+ "execution.batch_size": "8192"
+ "sql_parser.enable_ident_normalization": "true"
+The datafusion field accepts a map of configuration key-value pairs where
+both keys and values are strings. You can reference the DataFusion configuration documentation
+for a complete list of available configuration options.
Specify a config file on startup
+Use -c argument to run ROAPI using a specific config file:
roapi -c ./roapi.yml
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/config/dataset-formats/arrow.html b/config/dataset-formats/arrow.html
new file mode 100644
index 0000000..6faa97d
--- /dev/null
+++ b/config/dataset-formats/arrow.html
@@ -0,0 +1,237 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Databases
+Thanks to the connector-x Rust crate, +ROAPI is able to load tables from popular relational databases like MySQL, +PostgreSQL and SQLite.
+tables:
+ - name: "table_foo"
+ uri: "mysql://username:password@localhost:3306/database"
+ - name: "table_bar"
+ uri: "mysql://username:password@localhost:3306/database"
+ - name: "table_baz"
+ uri: "sqlite://path/to/sqlitelite/file"
+With this, you can now write a single SQL query to join tables between MySQL, SQLite and local CSV files!
+By default, ROAPI will use the provided table name as the table name to extract
+data from the database. If you want to expose a specific database table with a
+different name, you can use the option field to specify the original table
+name like below:
tables:
+ - name: custom_table_name
+ uri: "sqlite://path/to/sqlitelite/file"
+ option:
+ table: original_table_name
+ format: sqlite
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/config/dataset-formats/csv.html b/config/dataset-formats/csv.html
new file mode 100644
index 0000000..2f925cb
--- /dev/null
+++ b/config/dataset-formats/csv.html
@@ -0,0 +1,237 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Arrow
+When a table uri ends in .arrow or .arrows, ROAPI will try to load it as
+Arrow IPC file or stream if no format option is specified:
tables:
+ - name: "mytable"
+ uri: "http://mytable.arrow/" # or .arrows
+You can partition an Arrow dataset into multiple partitions and load all of them +into a single table by directory path:
+tables:
+ - name: "mytable"
+ uri: "./table_dir"
+ option:
+ format: "arrow" # or arrows
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/config/dataset-formats/delta.html b/config/dataset-formats/delta.html
new file mode 100644
index 0000000..2111281
--- /dev/null
+++ b/config/dataset-formats/delta.html
@@ -0,0 +1,255 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CSV
+When a table uri ends in .csv, ROAPI will try to load it as CSV table if no
+format option is specified:
tables:
+ - name: "mytable"
+ uri: "http://mytable.csv/"
+You can partition a CSV dataset into multiple partitions and load all of them +into a single table by directory path:
+tables:
+ - name: "mytable"
+ uri: "./table_dir"
+ option:
+ format: "csv"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/config/dataset-formats/excel.html b/config/dataset-formats/excel.html
new file mode 100644
index 0000000..8ea299d
--- /dev/null
+++ b/config/dataset-formats/excel.html
@@ -0,0 +1,307 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Delta Lake
+ROAPI supports loading Delta tables from Delta Lake
+through delta-rs. Since a Delta table
+doesn't have an extension suffix, ROAPI cannot infer table format from table
+URI alone. Therefore, the format option needs to be set to delta
+explicitly for Delta table sources:
tables:
+ - name: "mytable"
+ uri: "s3://bucket/delta_table/path"
+ option:
+ format: "delta"
+Large Datasets
+ROAPI loads the entire table into memory as the default behavior. If your
+table is large or you want to avoid loading all data during startup, you can
+set an additional option use_memory_table: false (default: true). With that
+configuration, ROAPI will not copy the data into memory, but instructs datafusion
+to directly operate on the backing storage.
At the moment, this comes with the following limitations:
+-
+
- no nested schema: datafusion#83 +
- missing support for cloud storage: datafusion#616 +
Example:
+tables:
+ - name: "mytable"
+ uri: "./path/to/delta_table"
+ option:
+ format: "delta"
+ use_memory_table: false
+Note that when providing use_memory_table option, it becomes necessary to
+also specify the format.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/config/dataset-formats/gsheet.html b/config/dataset-formats/gsheet.html
new file mode 100644
index 0000000..8ceedbd
--- /dev/null
+++ b/config/dataset-formats/gsheet.html
@@ -0,0 +1,356 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Excel
+ROAPI supports loading Microsoft Excel compatible formats including xls, xlsx, xlsb, and ods files.
+tables:
+ - name: "mytable"
+ uri: "path/to/file.xlsx"
+ option:
+ format: "xlsx"
+ sheet_name: "Sheet1"
+Supported Formats
+-
+
- xls - Microsoft Excel 5.0/95 Workbook +
- xlsx - Excel Workbook +
- xlsb - Excel Binary Workbook +
- ods - OpenDocument Spreadsheet +
Sheet Selection
+You can specify which sheet to load from the spreadsheet using the sheet_name option. By default, ROAPI will use the first sheet if no sheet name is specified.
+
tables:
+ - name: "mytable"
+ uri: "path/to/file.xlsx"
+ option:
+ format: "xlsx"
+ sheet_name: "MyDataSheet"
+Table Range Options
+You can specify a specific range of cells to load from the spreadsheet: +You can specify a specific range of cells to load from the spreadsheet:
+-
+
- rows_range_start - The first row of the table containing column names (default: 0) +
- rows_range_end - The last row of the table (default: all rows) +
- columns_range_start - The first column of the table (default: 0) +
- columns_range_end - The last column of the table (default: all columns) +
tables:
+ - name: "mytable"
+ uri: "path/to/file.xlsx"
+ option:
+ format: "xlsx"
+ sheet_name: "Sheet1"
+ rows_range_start: 1
+ rows_range_end: 4
+ columns_range_start: 1
+ columns_range_end: 3
+Schema Inference
+ROAPI can automatically infer the schema from your Excel data. The first row within the specified range is treated as column names, and ROAPI will analyze the remaining rows to determine data types.
+You can control schema inference with the schema_inference_lines option, which specifies how many rows to analyze (including the header row). For example, schema_inference_lines: 3 will use the first row for column names and analyze 2 additional rows for data types.
If a column contains mixed data types (like both integers and floats), ROAPI will default to the Utf8 (string) data type.
+Explicit Schema Definition
+For better performance and predictable data types, you can define the schema explicitly in your configuration:
+tables:
+ - name: "excel_table"
+ uri: "path/to/file.xlsx"
+ option:
+ format: "xlsx"
+ schema:
+ columns:
+ - name: "int_column"
+ data_type: "Int64"
+ nullable: true
+ - name: "string_column"
+ data_type: "Utf8"
+ nullable: true
+ - name: "float_column"
+ data_type: "Float64"
+ nullable: true
+ - name: "datetime_column"
+ data_type: !Timestamp [Seconds, null]
+ nullable: true
+ - name: "duration_column"
+ data_type: !Duration Second
+ nullable: true
+ - name: "date32_column"
+ data_type: Date32
+ nullable: true
+ - name: "date64_column"
+ data_type: Date64
+ nullable: true
+ - name: "null_column"
+ data_type: Null
+ nullable: true
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/config/dataset-formats/index.html b/config/dataset-formats/index.html
new file mode 100644
index 0000000..be67eeb
--- /dev/null
+++ b/config/dataset-formats/index.html
@@ -0,0 +1,223 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Google spreadsheet
+To serve a Google spreadsheet as API, you need to gather the following config values:
+-
+
- Google spreadsheet URL, usually in the form of
https://docs.google.com/spreadsheets/d/{SPREADSHEET_ID}#gid={SHEET_ID}.
+ - (Optional) Google spreadsheet sheet title (bottom of the spreadsheet UI).
+This is required if
SHEET_IDis not specified in URL through#gid.
+ - Google spreadsheet service account secret key. +
Here are the steps to configure the service account:
+-
+
- Activate Google Sheets API in the Google API Console. +
- Create a service account: https://console.developers.google.com/apis/api/sheets.googleapis.com/credentials. +
- Go into service account setting, click
ADD KEY->Create new key. Then select JSON format +and save it somewhere safe as a file.
+ - Copy email address for your newly created service account, usually in the format of
{ACCOUNT_NAME}@{PROJECT_ID}.iam.gserviceaccount.com.
+ - Open the Google spreadsheet that you want to serve, then share it with the newly created service
+account using the service account email.
+
Now you can configure ROAPI to load the google spreadsheet into a table using:
+tables:
+ - name: "table_name"
+ uri: "https://docs.google.com/spreadsheets/d/1-lc4oij04aXzFSRMwVBLjU76s-K0-s6UPc2biOvtuuU#gid=0"
+ option:
+ format: "google_spreadsheet"
+ application_secret_path: "path/to/service_account_key.json"
+ # sheet_title is optional if `#gid` is specified in uri
+ sheet_title: "sheet_name_within_google_spreadsheet"
+ROAPI only invokes Google Sheets API during the initial data load, subsequent +query requests are served using in memory data.
+Example
+Here is what it looks like to serve this public google +spreadsheet +with ROAPI.
+Start server:
+$ roapi -c local.yaml
+[2022-05-31T01:07:55Z INFO roapi::context] loading `uri(https://docs.google.com/spreadsheets/d/1-lc4oij04aXzFSRMwVBLjU76s-K0-s6UPc2biOvtuuU#gid=0)` as table `properties`
+[2022-05-31T01:07:56Z INFO roapi::context] registered `uri(https://docs.google.com/spreadsheets/d/1-lc4oij04aXzFSRMwVBLjU76s-K0-s6UPc2biOvtuuU#gid=0)` as table `properties`
+[2022-05-31T01:07:56Z INFO roapi::startup] 🚀 Listening on 127.0.0.1:5432 for Postgres traffic...
+[2022-05-31T01:07:56Z INFO roapi::startup] 🚀 Listening on 127.0.0.1:8080 for HTTP traffic...
+Query through Postgres wire protocol:
+$ psql -h 127.0.0.1
+psql (12.10 (Ubuntu 12.10-0ubuntu0.20.04.1), server 13)
+WARNING: psql major version 12, server major version 13.
+ Some psql features might not work.
+Type "help" for help.
+
+houqp=> select "Address", "Bed", "Bath", "Occupied" from properties;
+ Address | Bed | Bath | Occupied
+------------------+-----+------+----------
+ Bothell, WA | 3 | 2 | f
+ Lynnwood, WA | 2 | 1 | f
+ Kirkland, WA | 4 | 2 | f
+ Kent, WA | 3 | 2 | f
+ Mount Vernon, WA | 2 | 1 | f
+ Seattle, WA | 3 | 1 | f
+ Seattle, WA | 2 | 1 | f
+ Shoreline, WA | 1 | 1 | f
+ Bellevue, WA | 3 | 1 | f
+ Renton, WA | 4 | 2 | f
+ Woodinville, WA | 3 | 3 | f
+ Kenmore, WA | 4 | 3 | f
+ Fremont, WA | 5 | 3 | f
+ Redmond, WA | 2 | 2 | f
+ Mill Creek, WA | 3 | 3 | f
+(15 rows)
+Query with aggregation using HTTP SQL frontend:
+$ curl -s -X POST localhost:8080/api/sql --data-binary @- <<EOF | jq
+SELECT DISTINCT("Landlord"), COUNT("Address")
+FROM properties
+GROUP BY "Landlord"
+EOF
+
+[
+ {
+ "Landlord": "Carl",
+ "COUNT(properties.Address)": 3
+ },
+ {
+ "Landlord": "Roger",
+ "COUNT(properties.Address)": 3
+ },
+ {
+ "Landlord": "Mike",
+ "COUNT(properties.Address)": 4
+ },
+ {
+ "Landlord": "Sam",
+ "COUNT(properties.Address)": 2
+ },
+ {
+ "Landlord": "Daniel",
+ "COUNT(properties.Address)": 3
+ }
+]
+Query with filter using HTTP GraphQL frontend:
+$ curl -s -X POST localhost:8080/api/graphql --data-binary @- <<EOF | jq
+query {
+ properties(
+ filter: {
+ Bed: { gt: 3 }
+ Bath: { gte: 3 }
+ }
+ sort: [
+ { field: "Bed", order: "desc" }
+ ]
+ ) {
+ Address
+ Bed
+ Bath
+ Monthly_Rent
+ }
+}
+EOF
+[
+ {
+ "Address": "Fremont, WA",
+ "Bed": 5,
+ "Bath": 3,
+ "Monthly_Rent": "$4,500"
+ },
+ {
+ "Address": "Kenmore, WA",
+ "Bed": 4,
+ "Bath": 3,
+ "Monthly_Rent": "$4,000"
+ }
+]
+Note: when inferring table schema from Google spreadsheets, ROAPI automatically
+replaces spaces in column names with _(underscore).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/config/dataset-formats/json.html b/config/dataset-formats/json.html
new file mode 100644
index 0000000..0dd2541
--- /dev/null
+++ b/config/dataset-formats/json.html
@@ -0,0 +1,280 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Dataset formats
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/config/dataset-formats/ndjson.html b/config/dataset-formats/ndjson.html
new file mode 100644
index 0000000..0f2c395
--- /dev/null
+++ b/config/dataset-formats/ndjson.html
@@ -0,0 +1,232 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ JSON
+When a table uri ends in .json, ROAPI will try to load it as JSON table if no
+format option is specified:
tables:
+ - name: "mytable"
+ uri: "http://mytable.json/"
+Filter by JSON pointer
+Sometimes the JSON array you want to serve might be stored inside a JSON +object. To support this use-case, ROAPI supports loading JSON using a JSON +pointer.
+Take the following JSON data as an example:
+{
+ "x": {
+ "y": [{"col1": "z"}, {"col1": "zz"}]
+ }
+}
+In order to only serve [{"col1": "z"}, {"col1": "zz"}] through ROAPI, you can
+configure the JSON table source as:
tables:
+ - name: "mytable"
+ uri: "http://mytable.json/"
+ option:
+ format: "json"
+ pointer: "/x/y"
+Array encoding
+Each row in JSON data can be encoded using array for size reduction. This +convention allows us to avoid repeating column names in every row.
+For example:
+[
+ {"col1": 1, "col2": "abc"},
+ {"col1": 2, "col2": "efg"}
+]
+Can be stored as:
+[
+ [1, "abc"],
+ [2, "efg"]
+]
+However, when loading JSON rows using array encoding, you must explicitly specify +the schema, since there is no column name in the datasource anymore for ROAPI to +perform the schema inference.
+tables:
+ - name: "mytable"
+ uri: "http://mytable.json/"
+ option:
+ format: "json"
+ array_encoded: true
+ schema:
+ columns:
+ - name: "col1"
+ data_type: "Int64"
+ - name: "col2"
+ data_type: "Utf8"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/config/dataset-formats/parquet.html b/config/dataset-formats/parquet.html
new file mode 100644
index 0000000..5abc1a2
--- /dev/null
+++ b/config/dataset-formats/parquet.html
@@ -0,0 +1,258 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ NDJSON
+NDJSON stands for Newline delimited JSON. It is a +convenient format for storing or streaming structured data that may be +processed one record at a time.
+When a table uri ends in .ndjson, ROAPI will try to load it as NDJSON table
+if no format option is specified:
tables:
+ - name: "mytable"
+ uri: "http://mytable.ndjson/"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/config/index.html b/config/index.html
new file mode 100644
index 0000000..6de7de6
--- /dev/null
+++ b/config/index.html
@@ -0,0 +1,223 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parquet
+When a table uri ends in .parquet, ROAPI will try to load it as Parquet table if no
+format option is specified:
tables:
+ - name: "mytable"
+ uri: "http://mytable.parquet/"
+You can partition a Parquet dataset into multiple partitions and load all of them +into a single table by directory path:
+tables:
+ - name: "mytable"
+ uri: "./table_dir"
+ option:
+ format: "parquet"
+Large Datasets
+ROAPI loads the entire table into memory as the default behavior. If your
+table is large or you want to avoid loading all data during startup, you can
+set an additional option use_memory_table: false (default: true). With that
+configuration, ROAPI will not copy the data into memory, but instructs datafusion
+to directly operate on the backing storage.
At the moment, this comes with the following limitations:
+-
+
- no nested schema: datafusion#83 +
- missing support for cloud storage: datafusion#616 +
Example:
+tables:
+ - name: "mytable"
+ uri: "./table_dir"
+ option:
+ format: "parquet"
+ use_memory_table: false
+Note that when providing use_memory_table option, it becomes necessary to
+also specify the format.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/css/chrome.css b/css/chrome.css
new file mode 100644
index 0000000..4cd7308
--- /dev/null
+++ b/css/chrome.css
@@ -0,0 +1,640 @@
+/* CSS for UI elements (a.k.a. chrome) */
+
+html {
+ scrollbar-color: var(--scrollbar) var(--bg);
+}
+#searchresults a,
+.content a:link,
+a:visited,
+a > .hljs {
+ color: var(--links);
+}
+
+/*
+ body-container is necessary because mobile browsers don't seem to like
+ overflow-x on the body tag when there is a tag.
+*/
+#body-container {
+ /*
+ This is used when the sidebar pushes the body content off the side of
+ the screen on small screens. Without it, dragging on mobile Safari
+ will want to reposition the viewport in a weird way.
+ */
+ overflow-x: clip;
+}
+
+/* Menu Bar */
+
+#menu-bar,
+#menu-bar-hover-placeholder {
+ z-index: 101;
+ margin: auto calc(0px - var(--page-padding));
+}
+#menu-bar {
+ position: relative;
+ display: flex;
+ flex-wrap: wrap;
+ background-color: var(--bg);
+ border-block-end-color: var(--bg);
+ border-block-end-width: 1px;
+ border-block-end-style: solid;
+}
+#menu-bar.sticky,
+#menu-bar-hover-placeholder:hover + #menu-bar,
+#menu-bar:hover,
+html.sidebar-visible #menu-bar {
+ position: -webkit-sticky;
+ position: sticky;
+ top: 0 !important;
+}
+#menu-bar-hover-placeholder {
+ position: sticky;
+ position: -webkit-sticky;
+ top: 0;
+ height: var(--menu-bar-height);
+}
+#menu-bar.bordered {
+ border-block-end-color: var(--table-border-color);
+}
+#menu-bar i, #menu-bar .icon-button {
+ position: relative;
+ padding: 0 8px;
+ z-index: 10;
+ line-height: var(--menu-bar-height);
+ cursor: pointer;
+ transition: color 0.5s;
+}
+@media only screen and (max-width: 420px) {
+ #menu-bar i, #menu-bar .icon-button {
+ padding: 0 5px;
+ }
+}
+
+.icon-button {
+ border: none;
+ background: none;
+ padding: 0;
+ color: inherit;
+}
+.icon-button i {
+ margin: 0;
+}
+
+.right-buttons {
+ margin: 0 15px;
+}
+.right-buttons a {
+ text-decoration: none;
+}
+
+.left-buttons {
+ display: flex;
+ margin: 0 5px;
+}
+html:not(.js) .left-buttons button {
+ display: none;
+}
+
+.menu-title {
+ display: inline-block;
+ font-weight: 200;
+ font-size: 2.4rem;
+ line-height: var(--menu-bar-height);
+ text-align: center;
+ margin: 0;
+ flex: 1;
+ white-space: nowrap;
+ overflow: hidden;
+ text-overflow: ellipsis;
+}
+.menu-title {
+ cursor: pointer;
+}
+
+.menu-bar,
+.menu-bar:visited,
+.nav-chapters,
+.nav-chapters:visited,
+.mobile-nav-chapters,
+.mobile-nav-chapters:visited,
+.menu-bar .icon-button,
+.menu-bar a i {
+ color: var(--icons);
+}
+
+.menu-bar i:hover,
+.menu-bar .icon-button:hover,
+.nav-chapters:hover,
+.mobile-nav-chapters i:hover {
+ color: var(--icons-hover);
+}
+
+/* Nav Icons */
+
+.nav-chapters {
+ font-size: 2.5em;
+ text-align: center;
+ text-decoration: none;
+
+ position: fixed;
+ top: 0;
+ bottom: 0;
+ margin: 0;
+ max-width: 150px;
+ min-width: 90px;
+
+ display: flex;
+ justify-content: center;
+ align-content: center;
+ flex-direction: column;
+
+ transition: color 0.5s, background-color 0.5s;
+}
+
+.nav-chapters:hover {
+ text-decoration: none;
+ background-color: var(--theme-hover);
+ transition: background-color 0.15s, color 0.15s;
+}
+
+.nav-wrapper {
+ margin-block-start: 50px;
+ display: none;
+}
+
+.mobile-nav-chapters {
+ font-size: 2.5em;
+ text-align: center;
+ text-decoration: none;
+ width: 90px;
+ border-radius: 5px;
+ background-color: var(--sidebar-bg);
+}
+
+/* Only Firefox supports flow-relative values */
+.previous { float: left; }
+[dir=rtl] .previous { float: right; }
+
+/* Only Firefox supports flow-relative values */
+.next {
+ float: right;
+ right: var(--page-padding);
+}
+[dir=rtl] .next {
+ float: left;
+ right: unset;
+ left: var(--page-padding);
+}
+
+/* Use the correct buttons for RTL layouts*/
+[dir=rtl] .previous i.fa-angle-left:before {content:"\f105";}
+[dir=rtl] .next i.fa-angle-right:before { content:"\f104"; }
+
+@media only screen and (max-width: 1080px) {
+ .nav-wide-wrapper { display: none; }
+ .nav-wrapper { display: block; }
+}
+
+/* sidebar-visible */
+@media only screen and (max-width: 1380px) {
+ #sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wide-wrapper { display: none; }
+ #sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wrapper { display: block; }
+}
+
+/* Inline code */
+
+:not(pre) > .hljs {
+ display: inline;
+ padding: 0.1em 0.3em;
+ border-radius: 3px;
+}
+
+:not(pre):not(a) > .hljs {
+ color: var(--inline-code-color);
+ overflow-x: initial;
+}
+
+a:hover > .hljs {
+ text-decoration: underline;
+}
+
+pre {
+ position: relative;
+}
+pre > .buttons {
+ position: absolute;
+ z-index: 100;
+ right: 0px;
+ top: 2px;
+ margin: 0px;
+ padding: 2px 0px;
+
+ color: var(--sidebar-fg);
+ cursor: pointer;
+ visibility: hidden;
+ opacity: 0;
+ transition: visibility 0.1s linear, opacity 0.1s linear;
+}
+pre:hover > .buttons {
+ visibility: visible;
+ opacity: 1
+}
+pre > .buttons :hover {
+ color: var(--sidebar-active);
+ border-color: var(--icons-hover);
+ background-color: var(--theme-hover);
+}
+pre > .buttons i {
+ margin-inline-start: 8px;
+}
+pre > .buttons button {
+ cursor: inherit;
+ margin: 0px 5px;
+ padding: 4px 4px 3px 5px;
+ font-size: 23px;
+
+ border-style: solid;
+ border-width: 1px;
+ border-radius: 4px;
+ border-color: var(--icons);
+ background-color: var(--theme-popup-bg);
+ transition: 100ms;
+ transition-property: color,border-color,background-color;
+ color: var(--icons);
+}
+
+pre > .buttons button.clip-button {
+ padding: 2px 4px 0px 6px;
+}
+pre > .buttons button.clip-button::before {
+ /* clipboard image from octicons (https://github.com/primer/octicons/tree/v2.0.0) MIT license
+ */
+ content: url('data:image/svg+xml,');
+ filter: var(--copy-button-filter);
+}
+pre > .buttons button.clip-button:hover::before {
+ filter: var(--copy-button-filter-hover);
+}
+
+@media (pointer: coarse) {
+ pre > .buttons button {
+ /* On mobile, make it easier to tap buttons. */
+ padding: 0.3rem 1rem;
+ }
+
+ .sidebar-resize-indicator {
+ /* Hide resize indicator on devices with limited accuracy */
+ display: none;
+ }
+}
+pre > code {
+ display: block;
+ padding: 1rem;
+}
+
+/* FIXME: ACE editors overlap their buttons because ACE does absolute
+ positioning within the code block which breaks padding. The only solution I
+ can think of is to move the padding to the outer pre tag (or insert a div
+ wrapper), but that would require fixing a whole bunch of CSS rules.
+*/
+.hljs.ace_editor {
+ padding: 0rem 0rem;
+}
+
+pre > .result {
+ margin-block-start: 10px;
+}
+
+/* Search */
+
+#searchresults a {
+ text-decoration: none;
+}
+
+mark {
+ border-radius: 2px;
+ padding-block-start: 0;
+ padding-block-end: 1px;
+ padding-inline-start: 3px;
+ padding-inline-end: 3px;
+ margin-block-start: 0;
+ margin-block-end: -1px;
+ margin-inline-start: -3px;
+ margin-inline-end: -3px;
+ background-color: var(--search-mark-bg);
+ transition: background-color 300ms linear;
+ cursor: pointer;
+}
+
+mark.fade-out {
+ background-color: rgba(0,0,0,0) !important;
+ cursor: auto;
+}
+
+.searchbar-outer {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+}
+
+#searchbar {
+ width: 100%;
+ margin-block-start: 5px;
+ margin-block-end: 0;
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ padding: 10px 16px;
+ transition: box-shadow 300ms ease-in-out;
+ border: 1px solid var(--searchbar-border-color);
+ border-radius: 3px;
+ background-color: var(--searchbar-bg);
+ color: var(--searchbar-fg);
+}
+#searchbar:focus,
+#searchbar.active {
+ box-shadow: 0 0 3px var(--searchbar-shadow-color);
+}
+
+.searchresults-header {
+ font-weight: bold;
+ font-size: 1em;
+ padding-block-start: 18px;
+ padding-block-end: 0;
+ padding-inline-start: 5px;
+ padding-inline-end: 0;
+ color: var(--searchresults-header-fg);
+}
+
+.searchresults-outer {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+ border-block-end: 1px dashed var(--searchresults-border-color);
+}
+
+ul#searchresults {
+ list-style: none;
+ padding-inline-start: 20px;
+}
+ul#searchresults li {
+ margin: 10px 0px;
+ padding: 2px;
+ border-radius: 2px;
+}
+ul#searchresults li.focus {
+ background-color: var(--searchresults-li-bg);
+}
+ul#searchresults span.teaser {
+ display: block;
+ clear: both;
+ margin-block-start: 5px;
+ margin-block-end: 0;
+ margin-inline-start: 20px;
+ margin-inline-end: 0;
+ font-size: 0.8em;
+}
+ul#searchresults span.teaser em {
+ font-weight: bold;
+ font-style: normal;
+}
+
+/* Sidebar */
+
+.sidebar {
+ position: fixed;
+ left: 0;
+ top: 0;
+ bottom: 0;
+ width: var(--sidebar-width);
+ font-size: 0.875em;
+ box-sizing: border-box;
+ -webkit-overflow-scrolling: touch;
+ overscroll-behavior-y: contain;
+ background-color: var(--sidebar-bg);
+ color: var(--sidebar-fg);
+}
+.sidebar-iframe-inner {
+ background-color: var(--sidebar-bg);
+ color: var(--sidebar-fg);
+ padding: 10px 10px;
+ margin: 0;
+ font-size: 1.4rem;
+}
+.sidebar-iframe-outer {
+ border: none;
+ height: 100%;
+ position: absolute;
+ top: 0;
+ bottom: 0;
+ left: 0;
+ right: 0;
+}
+[dir=rtl] .sidebar { left: unset; right: 0; }
+.sidebar-resizing {
+ -moz-user-select: none;
+ -webkit-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+html:not(.sidebar-resizing) .sidebar {
+ transition: transform 0.3s; /* Animation: slide away */
+}
+.sidebar code {
+ line-height: 2em;
+}
+.sidebar .sidebar-scrollbox {
+ overflow-y: auto;
+ position: absolute;
+ top: 0;
+ bottom: 0;
+ left: 0;
+ right: 0;
+ padding: 10px 10px;
+}
+.sidebar .sidebar-resize-handle {
+ position: absolute;
+ cursor: col-resize;
+ width: 0;
+ right: calc(var(--sidebar-resize-indicator-width) * -1);
+ top: 0;
+ bottom: 0;
+ display: flex;
+ align-items: center;
+}
+
+.sidebar-resize-handle .sidebar-resize-indicator {
+ width: 100%;
+ height: 12px;
+ background-color: var(--icons);
+ margin-inline-start: var(--sidebar-resize-indicator-space);
+}
+
+[dir=rtl] .sidebar .sidebar-resize-handle {
+ left: calc(var(--sidebar-resize-indicator-width) * -1);
+ right: unset;
+}
+.js .sidebar .sidebar-resize-handle {
+ cursor: col-resize;
+ width: calc(var(--sidebar-resize-indicator-width) - var(--sidebar-resize-indicator-space));
+}
+/* sidebar-hidden */
+#sidebar-toggle-anchor:not(:checked) ~ .sidebar {
+ transform: translateX(calc(0px - var(--sidebar-width) - var(--sidebar-resize-indicator-width)));
+ z-index: -1;
+}
+[dir=rtl] #sidebar-toggle-anchor:not(:checked) ~ .sidebar {
+ transform: translateX(calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width)));
+}
+.sidebar::-webkit-scrollbar {
+ background: var(--sidebar-bg);
+}
+.sidebar::-webkit-scrollbar-thumb {
+ background: var(--scrollbar);
+}
+
+/* sidebar-visible */
+#sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: translateX(calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width)));
+}
+[dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: translateX(calc(0px - var(--sidebar-width) - var(--sidebar-resize-indicator-width)));
+}
+@media only screen and (min-width: 620px) {
+ #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: none;
+ margin-inline-start: calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width));
+ }
+ [dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: none;
+ }
+}
+
+.chapter {
+ list-style: none outside none;
+ padding-inline-start: 0;
+ line-height: 2.2em;
+}
+
+.chapter ol {
+ width: 100%;
+}
+
+.chapter li {
+ display: flex;
+ color: var(--sidebar-non-existant);
+}
+.chapter li a {
+ display: block;
+ padding: 0;
+ text-decoration: none;
+ color: var(--sidebar-fg);
+}
+
+.chapter li a:hover {
+ color: var(--sidebar-active);
+}
+
+.chapter li a.active {
+ color: var(--sidebar-active);
+}
+
+.chapter li > a.toggle {
+ cursor: pointer;
+ display: block;
+ margin-inline-start: auto;
+ padding: 0 10px;
+ user-select: none;
+ opacity: 0.68;
+}
+
+.chapter li > a.toggle div {
+ transition: transform 0.5s;
+}
+
+/* collapse the section */
+.chapter li:not(.expanded) + li > ol {
+ display: none;
+}
+
+.chapter li.chapter-item {
+ line-height: 1.5em;
+ margin-block-start: 0.6em;
+}
+
+.chapter li.expanded > a.toggle div {
+ transform: rotate(90deg);
+}
+
+.spacer {
+ width: 100%;
+ height: 3px;
+ margin: 5px 0px;
+}
+.chapter .spacer {
+ background-color: var(--sidebar-spacer);
+}
+
+@media (-moz-touch-enabled: 1), (pointer: coarse) {
+ .chapter li a { padding: 5px 0; }
+ .spacer { margin: 10px 0; }
+}
+
+.section {
+ list-style: none outside none;
+ padding-inline-start: 20px;
+ line-height: 1.9em;
+}
+
+/* Theme Menu Popup */
+
+.theme-popup {
+ position: absolute;
+ left: 10px;
+ top: var(--menu-bar-height);
+ z-index: 1000;
+ border-radius: 4px;
+ font-size: 0.7em;
+ color: var(--fg);
+ background: var(--theme-popup-bg);
+ border: 1px solid var(--theme-popup-border);
+ margin: 0;
+ padding: 0;
+ list-style: none;
+ display: none;
+ /* Don't let the children's background extend past the rounded corners. */
+ overflow: hidden;
+}
+[dir=rtl] .theme-popup { left: unset; right: 10px; }
+.theme-popup .default {
+ color: var(--icons);
+}
+.theme-popup .theme {
+ width: 100%;
+ border: 0;
+ margin: 0;
+ padding: 2px 20px;
+ line-height: 25px;
+ white-space: nowrap;
+ text-align: start;
+ cursor: pointer;
+ color: inherit;
+ background: inherit;
+ font-size: inherit;
+}
+.theme-popup .theme:hover {
+ background-color: var(--theme-hover);
+}
+
+.theme-selected::before {
+ display: inline-block;
+ content: "✓";
+ margin-inline-start: -14px;
+ width: 14px;
+}
diff --git a/css/general.css b/css/general.css
new file mode 100644
index 0000000..0862b51
--- /dev/null
+++ b/css/general.css
@@ -0,0 +1,242 @@
+/* Base styles and content styles */
+
+:root {
+ /* Browser default font-size is 16px, this way 1 rem = 10px */
+ font-size: 62.5%;
+ color-scheme: var(--color-scheme);
+}
+
+html {
+ font-family: "Open Sans", sans-serif;
+ color: var(--fg);
+ background-color: var(--bg);
+ text-size-adjust: none;
+ -webkit-text-size-adjust: none;
+}
+
+body {
+ margin: 0;
+ font-size: 1.6rem;
+ overflow-x: hidden;
+}
+
+code {
+ font-family: var(--mono-font) !important;
+ font-size: var(--code-font-size);
+ direction: ltr !important;
+}
+
+/* make long words/inline code not x overflow */
+main {
+ overflow-wrap: break-word;
+}
+
+/* make wide tables scroll if they overflow */
+.table-wrapper {
+ overflow-x: auto;
+}
+
+/* Don't change font size in headers. */
+h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
+ font-size: unset;
+}
+
+.left { float: left; }
+.right { float: right; }
+.boring { opacity: 0.6; }
+.hide-boring .boring { display: none; }
+.hidden { display: none !important; }
+
+h2, h3 { margin-block-start: 2.5em; }
+h4, h5 { margin-block-start: 2em; }
+
+.header + .header h3,
+.header + .header h4,
+.header + .header h5 {
+ margin-block-start: 1em;
+}
+
+h1:target::before,
+h2:target::before,
+h3:target::before,
+h4:target::before,
+h5:target::before,
+h6:target::before {
+ display: inline-block;
+ content: "»";
+ margin-inline-start: -30px;
+ width: 30px;
+}
+
+/* This is broken on Safari as of version 14, but is fixed
+ in Safari Technology Preview 117 which I think will be Safari 14.2.
+ https://bugs.webkit.org/show_bug.cgi?id=218076
+*/
+:target {
+ /* Safari does not support logical properties */
+ scroll-margin-top: calc(var(--menu-bar-height) + 0.5em);
+}
+
+.page {
+ outline: 0;
+ padding: 0 var(--page-padding);
+ margin-block-start: calc(0px - var(--menu-bar-height)); /* Compensate for the #menu-bar-hover-placeholder */
+}
+.page-wrapper {
+ box-sizing: border-box;
+ background-color: var(--bg);
+}
+.no-js .page-wrapper,
+.js:not(.sidebar-resizing) .page-wrapper {
+ transition: margin-left 0.3s ease, transform 0.3s ease; /* Animation: slide away */
+}
+[dir=rtl] .js:not(.sidebar-resizing) .page-wrapper {
+ transition: margin-right 0.3s ease, transform 0.3s ease; /* Animation: slide away */
+}
+
+.content {
+ overflow-y: auto;
+ padding: 0 5px 50px 5px;
+}
+.content main {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+}
+.content p { line-height: 1.45em; }
+.content ol { line-height: 1.45em; }
+.content ul { line-height: 1.45em; }
+.content a { text-decoration: none; }
+.content a:hover { text-decoration: underline; }
+.content img, .content video { max-width: 100%; }
+.content .header:link,
+.content .header:visited {
+ color: var(--fg);
+}
+.content .header:link,
+.content .header:visited:hover {
+ text-decoration: none;
+}
+
+table {
+ margin: 0 auto;
+ border-collapse: collapse;
+}
+table td {
+ padding: 3px 20px;
+ border: 1px var(--table-border-color) solid;
+}
+table thead {
+ background: var(--table-header-bg);
+}
+table thead td {
+ font-weight: 700;
+ border: none;
+}
+table thead th {
+ padding: 3px 20px;
+}
+table thead tr {
+ border: 1px var(--table-header-bg) solid;
+}
+/* Alternate background colors for rows */
+table tbody tr:nth-child(2n) {
+ background: var(--table-alternate-bg);
+}
+
+
+blockquote {
+ margin: 20px 0;
+ padding: 0 20px;
+ color: var(--fg);
+ background-color: var(--quote-bg);
+ border-block-start: .1em solid var(--quote-border);
+ border-block-end: .1em solid var(--quote-border);
+}
+
+.warning {
+ margin: 20px;
+ padding: 0 20px;
+ border-inline-start: 2px solid var(--warning-border);
+}
+
+.warning:before {
+ position: absolute;
+ width: 3rem;
+ height: 3rem;
+ margin-inline-start: calc(-1.5rem - 21px);
+ content: "ⓘ";
+ text-align: center;
+ background-color: var(--bg);
+ color: var(--warning-border);
+ font-weight: bold;
+ font-size: 2rem;
+}
+
+blockquote .warning:before {
+ background-color: var(--quote-bg);
+}
+
+kbd {
+ background-color: var(--table-border-color);
+ border-radius: 4px;
+ border: solid 1px var(--theme-popup-border);
+ box-shadow: inset 0 -1px 0 var(--theme-hover);
+ display: inline-block;
+ font-size: var(--code-font-size);
+ font-family: var(--mono-font);
+ line-height: 10px;
+ padding: 4px 5px;
+ vertical-align: middle;
+}
+
+sup {
+ /* Set the line-height for superscript and footnote references so that there
+ isn't an awkward space appearing above lines that contain the footnote.
+
+ See https://github.com/rust-lang/mdBook/pull/2443#discussion_r1813773583
+ for an explanation.
+ */
+ line-height: 0;
+}
+
+:not(.footnote-definition) + .footnote-definition,
+.footnote-definition + :not(.footnote-definition) {
+ margin-block-start: 2em;
+}
+.footnote-definition {
+ font-size: 0.9em;
+ margin: 0.5em 0;
+}
+.footnote-definition p {
+ display: inline;
+}
+
+.tooltiptext {
+ position: absolute;
+ visibility: hidden;
+ color: #fff;
+ background-color: #333;
+ transform: translateX(-50%); /* Center by moving tooltip 50% of its width left */
+ left: -8px; /* Half of the width of the icon */
+ top: -35px;
+ font-size: 0.8em;
+ text-align: center;
+ border-radius: 6px;
+ padding: 5px 8px;
+ margin: 5px;
+ z-index: 1000;
+}
+.tooltipped .tooltiptext {
+ visibility: visible;
+}
+
+.chapter li.part-title {
+ color: var(--sidebar-fg);
+ margin: 5px 0px;
+ font-weight: bold;
+}
+
+.result-no-output {
+ font-style: italic;
+}
diff --git a/css/print.css b/css/print.css
new file mode 100644
index 0000000..80ec3a5
--- /dev/null
+++ b/css/print.css
@@ -0,0 +1,50 @@
+
+#sidebar,
+#menu-bar,
+.nav-chapters,
+.mobile-nav-chapters {
+ display: none;
+}
+
+#page-wrapper.page-wrapper {
+ transform: none !important;
+ margin-inline-start: 0px;
+ overflow-y: initial;
+}
+
+#content {
+ max-width: none;
+ margin: 0;
+ padding: 0;
+}
+
+.page {
+ overflow-y: initial;
+}
+
+code {
+ direction: ltr !important;
+}
+
+pre > .buttons {
+ z-index: 2;
+}
+
+a, a:visited, a:active, a:hover {
+ color: #4183c4;
+ text-decoration: none;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ page-break-inside: avoid;
+ page-break-after: avoid;
+}
+
+pre, code {
+ page-break-inside: avoid;
+ white-space: pre-wrap;
+}
+
+.fa {
+ display: none !important;
+}
diff --git a/css/variables.css b/css/variables.css
new file mode 100644
index 0000000..12d1db7
--- /dev/null
+++ b/css/variables.css
@@ -0,0 +1,309 @@
+
+/* Globals */
+
+:root {
+ --sidebar-width: 300px;
+ --sidebar-resize-indicator-width: 8px;
+ --sidebar-resize-indicator-space: 2px;
+ --page-padding: 15px;
+ --content-max-width: 750px;
+ --menu-bar-height: 50px;
+ --mono-font: "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace;
+ --code-font-size: 0.875em /* please adjust the ace font size accordingly in editor.js */
+}
+
+/* Themes */
+
+.ayu {
+ --bg: hsl(210, 25%, 8%);
+ --fg: #c5c5c5;
+
+ --sidebar-bg: #14191f;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #5c6773;
+ --sidebar-active: #ffb454;
+ --sidebar-spacer: #2d334f;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #b7b9cc;
+
+ --links: #0096cf;
+
+ --inline-code-color: #ffb454;
+
+ --theme-popup-bg: #14191f;
+ --theme-popup-border: #5c6773;
+ --theme-hover: #191f26;
+
+ --quote-bg: hsl(226, 15%, 17%);
+ --quote-border: hsl(226, 15%, 22%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(210, 25%, 13%);
+ --table-header-bg: hsl(210, 25%, 28%);
+ --table-alternate-bg: hsl(210, 25%, 11%);
+
+ --searchbar-border-color: #848484;
+ --searchbar-bg: #424242;
+ --searchbar-fg: #fff;
+ --searchbar-shadow-color: #d4c89f;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #252932;
+ --search-mark-bg: #e3b171;
+
+ --color-scheme: dark;
+
+ /* Same as `--icons` */
+ --copy-button-filter: invert(45%) sepia(6%) saturate(621%) hue-rotate(198deg) brightness(99%) contrast(85%);
+ /* Same as `--sidebar-active` */
+ --copy-button-filter-hover: invert(68%) sepia(55%) saturate(531%) hue-rotate(341deg) brightness(104%) contrast(101%);
+}
+
+.coal {
+ --bg: hsl(200, 7%, 8%);
+ --fg: #98a3ad;
+
+ --sidebar-bg: #292c2f;
+ --sidebar-fg: #a1adb8;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #3473ad;
+ --sidebar-spacer: #393939;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #43484d;
+ --icons-hover: #b3c0cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #141617;
+ --theme-popup-border: #43484d;
+ --theme-hover: #1f2124;
+
+ --quote-bg: hsl(234, 21%, 18%);
+ --quote-border: hsl(234, 21%, 23%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(200, 7%, 13%);
+ --table-header-bg: hsl(200, 7%, 28%);
+ --table-alternate-bg: hsl(200, 7%, 11%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #b7b7b7;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #98a3ad;
+ --searchresults-li-bg: #2b2b2f;
+ --search-mark-bg: #355c7d;
+
+ --color-scheme: dark;
+
+ /* Same as `--icons` */
+ --copy-button-filter: invert(26%) sepia(8%) saturate(575%) hue-rotate(169deg) brightness(87%) contrast(82%);
+ /* Same as `--sidebar-active` */
+ --copy-button-filter-hover: invert(36%) sepia(70%) saturate(503%) hue-rotate(167deg) brightness(98%) contrast(89%);
+}
+
+.light, html:not(.js) {
+ --bg: hsl(0, 0%, 100%);
+ --fg: hsl(0, 0%, 0%);
+
+ --sidebar-bg: #fafafa;
+ --sidebar-fg: hsl(0, 0%, 0%);
+ --sidebar-non-existant: #aaaaaa;
+ --sidebar-active: #1f1fff;
+ --sidebar-spacer: #f4f4f4;
+
+ --scrollbar: #8F8F8F;
+
+ --icons: #747474;
+ --icons-hover: #000000;
+
+ --links: #20609f;
+
+ --inline-code-color: #301900;
+
+ --theme-popup-bg: #fafafa;
+ --theme-popup-border: #cccccc;
+ --theme-hover: #e6e6e6;
+
+ --quote-bg: hsl(197, 37%, 96%);
+ --quote-border: hsl(197, 37%, 91%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(0, 0%, 95%);
+ --table-header-bg: hsl(0, 0%, 80%);
+ --table-alternate-bg: hsl(0, 0%, 97%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #fafafa;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #e4f2fe;
+ --search-mark-bg: #a2cff5;
+
+ --color-scheme: light;
+
+ /* Same as `--icons` */
+ --copy-button-filter: invert(45.49%);
+ /* Same as `--sidebar-active` */
+ --copy-button-filter-hover: invert(14%) sepia(93%) saturate(4250%) hue-rotate(243deg) brightness(99%) contrast(130%);
+}
+
+.navy {
+ --bg: hsl(226, 23%, 11%);
+ --fg: #bcbdd0;
+
+ --sidebar-bg: #282d3f;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #505274;
+ --sidebar-active: #2b79a2;
+ --sidebar-spacer: #2d334f;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #b7b9cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #161923;
+ --theme-popup-border: #737480;
+ --theme-hover: #282e40;
+
+ --quote-bg: hsl(226, 15%, 17%);
+ --quote-border: hsl(226, 15%, 22%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(226, 23%, 16%);
+ --table-header-bg: hsl(226, 23%, 31%);
+ --table-alternate-bg: hsl(226, 23%, 14%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #aeaec6;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #5f5f71;
+ --searchresults-border-color: #5c5c68;
+ --searchresults-li-bg: #242430;
+ --search-mark-bg: #a2cff5;
+
+ --color-scheme: dark;
+
+ /* Same as `--icons` */
+ --copy-button-filter: invert(51%) sepia(10%) saturate(393%) hue-rotate(198deg) brightness(86%) contrast(87%);
+ /* Same as `--sidebar-active` */
+ --copy-button-filter-hover: invert(46%) sepia(20%) saturate(1537%) hue-rotate(156deg) brightness(85%) contrast(90%);
+}
+
+.rust {
+ --bg: hsl(60, 9%, 87%);
+ --fg: #262625;
+
+ --sidebar-bg: #3b2e2a;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #e69f67;
+ --sidebar-spacer: #45373a;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #262625;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #6e6b5e;
+
+ --theme-popup-bg: #e1e1db;
+ --theme-popup-border: #b38f6b;
+ --theme-hover: #99908a;
+
+ --quote-bg: hsl(60, 5%, 75%);
+ --quote-border: hsl(60, 5%, 70%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(60, 9%, 82%);
+ --table-header-bg: #b3a497;
+ --table-alternate-bg: hsl(60, 9%, 84%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #fafafa;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #dec2a2;
+ --search-mark-bg: #e69f67;
+
+ /* Same as `--icons` */
+ --copy-button-filter: invert(51%) sepia(10%) saturate(393%) hue-rotate(198deg) brightness(86%) contrast(87%);
+ /* Same as `--sidebar-active` */
+ --copy-button-filter-hover: invert(77%) sepia(16%) saturate(1798%) hue-rotate(328deg) brightness(98%) contrast(83%);
+}
+
+@media (prefers-color-scheme: dark) {
+ html:not(.js) {
+ --bg: hsl(200, 7%, 8%);
+ --fg: #98a3ad;
+
+ --sidebar-bg: #292c2f;
+ --sidebar-fg: #a1adb8;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #3473ad;
+ --sidebar-spacer: #393939;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #43484d;
+ --icons-hover: #b3c0cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #141617;
+ --theme-popup-border: #43484d;
+ --theme-hover: #1f2124;
+
+ --quote-bg: hsl(234, 21%, 18%);
+ --quote-border: hsl(234, 21%, 23%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(200, 7%, 13%);
+ --table-header-bg: hsl(200, 7%, 28%);
+ --table-alternate-bg: hsl(200, 7%, 11%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #b7b7b7;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #98a3ad;
+ --searchresults-li-bg: #2b2b2f;
+ --search-mark-bg: #355c7d;
+
+ --color-scheme: dark;
+
+ /* Same as `--icons` */
+ --copy-button-filter: invert(26%) sepia(8%) saturate(575%) hue-rotate(169deg) brightness(87%) contrast(82%);
+ /* Same as `--sidebar-active` */
+ --copy-button-filter-hover: invert(36%) sepia(70%) saturate(503%) hue-rotate(167deg) brightness(98%) contrast(89%);
+ }
+}
diff --git a/elasticlunr.min.js b/elasticlunr.min.js
new file mode 100644
index 0000000..94b20dd
--- /dev/null
+++ b/elasticlunr.min.js
@@ -0,0 +1,10 @@
+/**
+ * elasticlunr - http://weixsong.github.io
+ * Lightweight full-text search engine in Javascript for browser search and offline search. - 0.9.5
+ *
+ * Copyright (C) 2017 Oliver Nightingale
+ * Copyright (C) 2017 Wei Song
+ * MIT Licensed
+ * @license
+ */
+!function(){function e(e){if(null===e||"object"!=typeof e)return e;var t=e.constructor();for(var n in e)e.hasOwnProperty(n)&&(t[n]=e[n]);return t}var t=function(e){var n=new t.Index;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),e&&e.call(n,n),n};t.version="0.9.5",lunr=t,t.utils={},t.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),t.utils.toString=function(e){return void 0===e||null===e?"":e.toString()},t.EventEmitter=function(){this.events={}},t.EventEmitter.prototype.addListener=function(){var e=Array.prototype.slice.call(arguments),t=e.pop(),n=e;if("function"!=typeof t)throw new TypeError("last argument must be a function");n.forEach(function(e){this.hasHandler(e)||(this.events[e]=[]),this.events[e].push(t)},this)},t.EventEmitter.prototype.removeListener=function(e,t){if(this.hasHandler(e)){var n=this.events[e].indexOf(t);-1!==n&&(this.events[e].splice(n,1),0==this.events[e].length&&delete this.events[e])}},t.EventEmitter.prototype.emit=function(e){if(this.hasHandler(e)){var t=Array.prototype.slice.call(arguments,1);this.events[e].forEach(function(e){e.apply(void 0,t)},this)}},t.EventEmitter.prototype.hasHandler=function(e){return e in this.events},t.tokenizer=function(e){if(!arguments.length||null===e||void 0===e)return[];if(Array.isArray(e)){var n=e.filter(function(e){return null===e||void 0===e?!1:!0});n=n.map(function(e){return t.utils.toString(e).toLowerCase()});var i=[];return n.forEach(function(e){var n=e.split(t.tokenizer.seperator);i=i.concat(n)},this),i}return e.toString().trim().toLowerCase().split(t.tokenizer.seperator)},t.tokenizer.defaultSeperator=/[\s\-]+/,t.tokenizer.seperator=t.tokenizer.defaultSeperator,t.tokenizer.setSeperator=function(e){null!==e&&void 0!==e&&"object"==typeof e&&(t.tokenizer.seperator=e)},t.tokenizer.resetSeperator=function(){t.tokenizer.seperator=t.tokenizer.defaultSeperator},t.tokenizer.getSeperator=function(){return t.tokenizer.seperator},t.Pipeline=function(){this._queue=[]},t.Pipeline.registeredFunctions={},t.Pipeline.registerFunction=function(e,n){n in t.Pipeline.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[n]=e},t.Pipeline.getRegisteredFunction=function(e){return e in t.Pipeline.registeredFunctions!=!0?null:t.Pipeline.registeredFunctions[e]},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(e){var i=t.Pipeline.getRegisteredFunction(e);if(!i)throw new Error("Cannot load un-registered function: "+e);n.add(i)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(e){t.Pipeline.warnIfFunctionNotRegistered(e),this._queue.push(e)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i+1,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i,0,n)},t.Pipeline.prototype.remove=function(e){var t=this._queue.indexOf(e);-1!==t&&this._queue.splice(t,1)},t.Pipeline.prototype.run=function(e){for(var t=[],n=e.length,i=this._queue.length,o=0;n>o;o++){for(var r=e[o],s=0;i>s&&(r=this._queue[s](r,o,e),void 0!==r&&null!==r);s++);void 0!==r&&null!==r&&t.push(r)}return t},t.Pipeline.prototype.reset=function(){this._queue=[]},t.Pipeline.prototype.get=function(){return this._queue},t.Pipeline.prototype.toJSON=function(){return this._queue.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})},t.Index=function(){this._fields=[],this._ref="id",this.pipeline=new t.Pipeline,this.documentStore=new t.DocumentStore,this.index={},this.eventEmitter=new t.EventEmitter,this._idfCache={},this.on("add","remove","update",function(){this._idfCache={}}.bind(this))},t.Index.prototype.on=function(){var e=Array.prototype.slice.call(arguments);return this.eventEmitter.addListener.apply(this.eventEmitter,e)},t.Index.prototype.off=function(e,t){return this.eventEmitter.removeListener(e,t)},t.Index.load=function(e){e.version!==t.version&&t.utils.warn("version mismatch: current "+t.version+" importing "+e.version);var n=new this;n._fields=e.fields,n._ref=e.ref,n.documentStore=t.DocumentStore.load(e.documentStore),n.pipeline=t.Pipeline.load(e.pipeline),n.index={};for(var i in e.index)n.index[i]=t.InvertedIndex.load(e.index[i]);return n},t.Index.prototype.addField=function(e){return this._fields.push(e),this.index[e]=new t.InvertedIndex,this},t.Index.prototype.setRef=function(e){return this._ref=e,this},t.Index.prototype.saveDocument=function(e){return this.documentStore=new t.DocumentStore(e),this},t.Index.prototype.addDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.addDoc(i,e),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));this.documentStore.addFieldLength(i,n,o.length);var r={};o.forEach(function(e){e in r?r[e]+=1:r[e]=1},this);for(var s in r){var u=r[s];u=Math.sqrt(u),this.index[n].addToken(s,{ref:i,tf:u})}},this),n&&this.eventEmitter.emit("add",e,this)}},t.Index.prototype.removeDocByRef=function(e){if(e&&this.documentStore.isDocStored()!==!1&&this.documentStore.hasDoc(e)){var t=this.documentStore.getDoc(e);this.removeDoc(t,!1)}},t.Index.prototype.removeDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.hasDoc(i)&&(this.documentStore.removeDoc(i),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));o.forEach(function(e){this.index[n].removeToken(e,i)},this)},this),n&&this.eventEmitter.emit("remove",e,this))}},t.Index.prototype.updateDoc=function(e,t){var t=void 0===t?!0:t;this.removeDocByRef(e[this._ref],!1),this.addDoc(e,!1),t&&this.eventEmitter.emit("update",e,this)},t.Index.prototype.idf=function(e,t){var n="@"+t+"/"+e;if(Object.prototype.hasOwnProperty.call(this._idfCache,n))return this._idfCache[n];var i=this.index[t].getDocFreq(e),o=1+Math.log(this.documentStore.length/(i+1));return this._idfCache[n]=o,o},t.Index.prototype.getFields=function(){return this._fields.slice()},t.Index.prototype.search=function(e,n){if(!e)return[];e="string"==typeof e?{any:e}:JSON.parse(JSON.stringify(e));var i=null;null!=n&&(i=JSON.stringify(n));for(var o=new t.Configuration(i,this.getFields()).get(),r={},s=Object.keys(e),u=0;u
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Config
+ +":e:f.tabReplace?e.replace(/\t/g,f.tabReplace):e):e}function E(e){let n=null;const t=function(e){var n=e.className+" ";n+=e.parentNode?e.parentNode.className:"";const t=f.languageDetectRe.exec(n);if(t){var r=T(t[1]);return r||(console.warn(g.replace("{}",t[1])),console.warn("Falling back to no-highlight mode for this block.",e)),r?t[1]:"no-highlight"}return n.split(/\s+/).find(e=>p(e)||T(e))}(e);if(p(t))return;S("before:highlightBlock",{block:e,language:t}),f.useBR?(n=document.createElement("div")).innerHTML=e.innerHTML.replace(/\n/g,"").replace(/
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/installation.html b/installation.html
new file mode 100644
index 0000000..8192619
--- /dev/null
+++ b/installation.html
@@ -0,0 +1,240 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 
+
+
+
+
+ ROAPI Documentation
+
ROAPI automatically spins up read-only APIs +and query frontends for slowly moving datasets without requiring you to write a +single line of code. It builds on top of Apache Arrow and +Datafusion. The +core of its design can be boiled down to the following:
+-
+
- Query frontends to translate SQL, GraphQL and REST API queries into +Datafusion plans. +
- Datafusion for query plan execution. +
- Data layer to load datasets from a variety of sources and formats with +automatic schema inference. +
- Response encoding layer to serialize intermediate Arrow record batch into +various formats requested by client. +
Its pluggable query core design makes it possible for users to efficiently +perform join queries across a diverse set of datasources from simple +CSV/Parquet files in Data warehouses, to MySQL/Postgres, to SASS like Google +spreadsheet.
+See below for a high level design diagram:
+
+++ +If you'd like to share feedback on how you're using ROAPI, please fill out this survey. Thanks!
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/mark.min.js b/mark.min.js
new file mode 100644
index 0000000..1636231
--- /dev/null
+++ b/mark.min.js
@@ -0,0 +1,7 @@
+/*!***************************************************
+* mark.js v8.11.1
+* https://markjs.io/
+* Copyright (c) 2014–2018, Julian Kühnel
+* Released under the MIT license https://git.io/vwTVl
+*****************************************************/
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):e.Mark=t()}(this,function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},n=function(){function e(e,t){for(var n=0;n
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Installation
+Pre-built binary
+Platform specific pre-built binaries for each release are hosted on our Github +release page.
+You can download and install them with a single command using pip:
+pip install roapi
+If you are using homebrew, you can also install using brew command:
brew install roapi
+# notice that the binary itself is still roapi-http
+Docker
+Pre-built docker images are hosted at +ghcr.io/roapi/roapi.
+Build from source
+You need to install Rust toolchain if you haven't done so.
+cargo install --locked --git https://github.com/roapi/roapi --branch main --bins roapi
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/print.html b/print.html
new file mode 100644
index 0000000..85431e2
--- /dev/null
+++ b/print.html
@@ -0,0 +1,1065 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Postgres wire protocol
+ROAPI uses the convergence Rust +crate to read and write Postgres wire protocol. This means you will be able to +query all tables loaded in ROAPI using any Postgres Clients as if ROAPI is a +real Postgres database!
+By default, ROAPI listens for Postgres traffic on address 127.0.0.1:5432, but
+you can change it using the --addr-postgres command line argument or add the
+following to your config file:
addr:
+ # binding address for TCP port that speaks Postgres wire protocol
+ postgres: 0.0.0.0:5432
+Once ROAPI boots up, you can connect to it without authentication:
+$ psql -h 127.0.0.1
+psql (12.10 (Ubuntu 12.10-0ubuntu0.20.04.1), server 13)
+WARNING: psql major version 12, server major version 13.
+ Some psql features might not work.
+Type "help" for help.
+
+houqp=> select 1;
+ Int64(1)
+----------
+ 1
+(1 row)
+
+houqp=>
+See here for an example on how you can query data stored in a Google spreadsheet using the psql Postgres client.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/quickstart.html b/quickstart.html
new file mode 100644
index 0000000..3cc13e1
--- /dev/null
+++ b/quickstart.html
@@ -0,0 +1,289 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ROAPI Documentation
+ROAPI automatically spins up read-only APIs +and query frontends for slowly moving datasets without requiring you to write a +single line of code. It builds on top of Apache Arrow and +Datafusion. The +core of its design can be boiled down to the following:
+-
+
- Query frontends to translate SQL, GraphQL and REST API queries into +Datafusion plans. +
- Datafusion for query plan execution. +
- Data layer to load datasets from a variety of sources and formats with +automatic schema inference. +
- Response encoding layer to serialize intermediate Arrow record batch into +various formats requested by client. +
Its pluggable query core design makes it possible for users to efficiently +perform join queries across a diverse set of datasources from simple +CSV/Parquet files in Data warehouses, to MySQL/Postgres, to SASS like Google +spreadsheet.
+See below for a high level design diagram:
+
+++If you'd like to share feedback on how you're using ROAPI, please fill out this survey. Thanks!
+
Installation
+Pre-built binary
+Platform specific pre-built binaries for each release are hosted on our Github +release page.
+You can download and install them with a single command using pip:
+pip install roapi
+If you are using homebrew, you can also install using brew command:
brew install roapi
+# notice that the binary itself is still roapi-http
+Docker
+Pre-built docker images are hosted at +ghcr.io/roapi/roapi.
+Build from source
+You need to install Rust toolchain if you haven't done so.
+cargo install --locked --git https://github.com/roapi/roapi --branch main --bins roapi
+Quick start
+Spin up APIs for test_data/uk_cities_with_headers.csv and
+test_data/spacex-launches.json:
roapi \
+ --table "uk_cities=test_data/uk_cities_with_headers.csv" \
+ --table "test_data/spacex_launches.json"
+Or using prebuilt docker image:
+docker run -t --rm -p 8080:8080 ghcr.io/roapi/roapi:latest --addr-http 0.0.0.0:8080 \
+ --table "uk_cities=test_data/uk_cities_with_headers.csv" \
+ --table "test_data/spacex_launches.json"
+Query API
+Query tables using SQL, GraphQL or REST:
+curl -X POST -d "SELECT city, lat, lng FROM uk_cities LIMIT 2" localhost:8080/api/sql
+curl -X POST -d "query { uk_cities(limit: 2) {city, lat, lng} }" localhost:8080/api/graphql
+curl "localhost:8080/api/tables/uk_cities?columns=city,lat,lng&limit=2"
+Sample response:
+[
+ {
+ "city": "Elgin, Scotland, the UK",
+ "lat": 57.653484,
+ "lng": -3.335724
+ },
+ {
+ "city": "Stoke-on-Trent, Staffordshire, the UK",
+ "lat": 53.002666,
+ "lng": -2.179404
+ }
+]
+See Query frontends for details on different operators supported +by each frontend.
+Schema API
+Get inferred schema for all tables:
+curl localhost:8080/api/schema
+Sample response:
+{
+ "uk_cities": {
+ "fields": [
+ {
+ "name": "city",
+ "data_type": "Utf8",
+ "nullable": false,
+ "dict_id": 0,
+ "dict_is_ordered": false
+ },
+ {
+ "name": "lat",
+ "data_type": "Float64",
+ "nullable": false,
+ "dict_id": 0,
+ "dict_is_ordered": false
+ },
+ {
+ "name": "lng",
+ "data_type": "Float64",
+ "nullable": false,
+ "dict_id": 0,
+ "dict_is_ordered": false
+ }
+ ]
+ }
+}
+Config
+Command line argument
+You can configure ROAPI to load as many tables as you want by repeating the --table argument:
roapi --table 'table1_name=table1_uri' --table 'table2_name=table2_uri'
+You can use RUST_LOG environment variable to control the logging verbosity:
RUST_LOG=debug roapi ...
+Here is the output from roapi --help:
roapi 0.7.1
+QP Hou
+Create full-fledged APIs for static datasets without writing a single line of code.
+
+USAGE:
+ roapi [OPTIONS]
+
+OPTIONS:
+ -a, --addr-http <IP:PORT>
+ HTTP endpoint bind address
+
+ -c, --config <config>
+ config file path
+
+ -d, --disable-read-only
+ Start roapi in read write mode
+
+ -h, --help
+ Print help information
+
+ -p, --addr-postgres <IP:PORT>
+ Postgres endpoint bind address
+
+ -t, --table <[table_name=]uri[,option_key=option_value]>
+ Table sources to load. Table option can be provided as optional setting as part of the
+ table URI, for example: `blogs=s3://bucket/key,format=delta`. Set table uri to `stdin`
+ if you want to consume table data from stdin as part of a UNIX pipe. If no table_name is
+ provided, a table name will be derived from the filename in URI.
+
+ -V, --version
+ Print version information
+YAML config
+Tables
+You can configure multiple table sources using YAML config, which supports more +advanced format specific table options. For example:
+addr:
+ # binding address for TCP port that speaks HTTP protocol
+ http: 0.0.0.0:8080
+ # binding address for TCP port that speaks Postgres wire protocol
+ postgres: 0.0.0.0:5432
+tables:
+ - name: "blogs"
+ uri: "test_data/blogs.parquet"
+
+ - name: "ubuntu_ami"
+ uri: "test_data/ubuntu-ami.json"
+ option:
+ format: "json"
+ pointer: "/aaData"
+ array_encoded: true
+ schema:
+ columns:
+ - name: "zone"
+ data_type: "Utf8"
+ - name: "name"
+ data_type: "Utf8"
+ - name: "version"
+ data_type: "Utf8"
+ - name: "arch"
+ data_type: "Utf8"
+ - name: "instance_type"
+ data_type: "Utf8"
+ - name: "release"
+ data_type: "Utf8"
+ - name: "ami_id"
+ data_type: "Utf8"
+ - name: "aki_id"
+ data_type: "Utf8"
+
+ - name: "spacex_launches"
+ uri: "https://api.spacexdata.com/v4/launches"
+ option:
+ format: "json"
+
+ - name: "github_jobs"
+ uri: "https://web.archive.org/web/20210507025928if_/https://jobs.github.com/positions.json"
+Key value stores
+Table sources can be loaded into in-memory key value stores if you specify which two +columns to be used to load keys and values in the config:
+kvstores:
+ - name: "spacex_launch_name"
+ uri: "test_data/spacex_launches.json"
+ key: id
+ value: name
+The above config will create a keyvalue store named spacex_launch_name that allows you to lookup SpaceX launch names using launch ids.
DataFusion configuration
+You can override DataFusion configuration settings by specifying them in the datafusion section of your config file. This allows you to tune the query engine's behavior for your specific use case:
datafusion:
+ "execution.collect_statistics": "true"
+ "execution.batch_size": "8192"
+ "sql_parser.enable_ident_normalization": "true"
+The datafusion field accepts a map of configuration key-value pairs where
+both keys and values are strings. You can reference the DataFusion configuration documentation
+for a complete list of available configuration options.
Specify a config file on startup
+Use -c argument to run ROAPI using a specific config file:
roapi -c ./roapi.yml
+Dataset formats
+JSON
+When a table uri ends in .json, ROAPI will try to load it as JSON table if no
+format option is specified:
tables:
+ - name: "mytable"
+ uri: "http://mytable.json/"
+Filter by JSON pointer
+Sometimes the JSON array you want to serve might be stored inside a JSON +object. To support this use-case, ROAPI supports loading JSON using a JSON +pointer.
+Take the following JSON data as an example:
+{
+ "x": {
+ "y": [{"col1": "z"}, {"col1": "zz"}]
+ }
+}
+In order to only serve [{"col1": "z"}, {"col1": "zz"}] through ROAPI, you can
+configure the JSON table source as:
tables:
+ - name: "mytable"
+ uri: "http://mytable.json/"
+ option:
+ format: "json"
+ pointer: "/x/y"
+Array encoding
+Each row in JSON data can be encoded using array for size reduction. This +convention allows us to avoid repeating column names in every row.
+For example:
+[
+ {"col1": 1, "col2": "abc"},
+ {"col1": 2, "col2": "efg"}
+]
+Can be stored as:
+[
+ [1, "abc"],
+ [2, "efg"]
+]
+However, when loading JSON rows using array encoding, you must explicitly specify +the schema, since there is no column name in the datasource anymore for ROAPI to +perform the schema inference.
+tables:
+ - name: "mytable"
+ uri: "http://mytable.json/"
+ option:
+ format: "json"
+ array_encoded: true
+ schema:
+ columns:
+ - name: "col1"
+ data_type: "Int64"
+ - name: "col2"
+ data_type: "Utf8"
+Parquet
+When a table uri ends in .parquet, ROAPI will try to load it as Parquet table if no
+format option is specified:
tables:
+ - name: "mytable"
+ uri: "http://mytable.parquet/"
+You can partition a Parquet dataset into multiple partitions and load all of them +into a single table by directory path:
+tables:
+ - name: "mytable"
+ uri: "./table_dir"
+ option:
+ format: "parquet"
+Large Datasets
+ROAPI loads the entire table into memory as the default behavior. If your
+table is large or you want to avoid loading all data during startup, you can
+set an additional option use_memory_table: false (default: true). With that
+configuration, ROAPI will not copy the data into memory, but instructs datafusion
+to directly operate on the backing storage.
At the moment, this comes with the following limitations:
+-
+
- no nested schema: datafusion#83 +
- missing support for cloud storage: datafusion#616 +
Example:
+tables:
+ - name: "mytable"
+ uri: "./table_dir"
+ option:
+ format: "parquet"
+ use_memory_table: false
+Note that when providing use_memory_table option, it becomes necessary to
+also specify the format.
CSV
+When a table uri ends in .csv, ROAPI will try to load it as CSV table if no
+format option is specified:
tables:
+ - name: "mytable"
+ uri: "http://mytable.csv/"
+You can partition a CSV dataset into multiple partitions and load all of them +into a single table by directory path:
+tables:
+ - name: "mytable"
+ uri: "./table_dir"
+ option:
+ format: "csv"
+Google spreadsheet
+To serve a Google spreadsheet as API, you need to gather the following config values:
+-
+
- Google spreadsheet URL, usually in the form of
https://docs.google.com/spreadsheets/d/{SPREADSHEET_ID}#gid={SHEET_ID}.
+ - (Optional) Google spreadsheet sheet title (bottom of the spreadsheet UI).
+This is required if
SHEET_IDis not specified in URL through#gid.
+ - Google spreadsheet service account secret key. +
Here are the steps to configure the service account:
+-
+
- Activate Google Sheets API in the Google API Console. +
- Create a service account: https://console.developers.google.com/apis/api/sheets.googleapis.com/credentials. +
- Go into service account setting, click
ADD KEY->Create new key. Then select JSON format +and save it somewhere safe as a file.
+ - Copy email address for your newly created service account, usually in the format of
{ACCOUNT_NAME}@{PROJECT_ID}.iam.gserviceaccount.com.
+ - Open the Google spreadsheet that you want to serve, then share it with the newly created service
+account using the service account email.
+
Now you can configure ROAPI to load the google spreadsheet into a table using:
+tables:
+ - name: "table_name"
+ uri: "https://docs.google.com/spreadsheets/d/1-lc4oij04aXzFSRMwVBLjU76s-K0-s6UPc2biOvtuuU#gid=0"
+ option:
+ format: "google_spreadsheet"
+ application_secret_path: "path/to/service_account_key.json"
+ # sheet_title is optional if `#gid` is specified in uri
+ sheet_title: "sheet_name_within_google_spreadsheet"
+ROAPI only invokes Google Sheets API during the initial data load, subsequent +query requests are served using in memory data.
+Example
+Here is what it looks like to serve this public google +spreadsheet +with ROAPI.
+Start server:
+$ roapi -c local.yaml
+[2022-05-31T01:07:55Z INFO roapi::context] loading `uri(https://docs.google.com/spreadsheets/d/1-lc4oij04aXzFSRMwVBLjU76s-K0-s6UPc2biOvtuuU#gid=0)` as table `properties`
+[2022-05-31T01:07:56Z INFO roapi::context] registered `uri(https://docs.google.com/spreadsheets/d/1-lc4oij04aXzFSRMwVBLjU76s-K0-s6UPc2biOvtuuU#gid=0)` as table `properties`
+[2022-05-31T01:07:56Z INFO roapi::startup] 🚀 Listening on 127.0.0.1:5432 for Postgres traffic...
+[2022-05-31T01:07:56Z INFO roapi::startup] 🚀 Listening on 127.0.0.1:8080 for HTTP traffic...
+Query through Postgres wire protocol:
+$ psql -h 127.0.0.1
+psql (12.10 (Ubuntu 12.10-0ubuntu0.20.04.1), server 13)
+WARNING: psql major version 12, server major version 13.
+ Some psql features might not work.
+Type "help" for help.
+
+houqp=> select "Address", "Bed", "Bath", "Occupied" from properties;
+ Address | Bed | Bath | Occupied
+------------------+-----+------+----------
+ Bothell, WA | 3 | 2 | f
+ Lynnwood, WA | 2 | 1 | f
+ Kirkland, WA | 4 | 2 | f
+ Kent, WA | 3 | 2 | f
+ Mount Vernon, WA | 2 | 1 | f
+ Seattle, WA | 3 | 1 | f
+ Seattle, WA | 2 | 1 | f
+ Shoreline, WA | 1 | 1 | f
+ Bellevue, WA | 3 | 1 | f
+ Renton, WA | 4 | 2 | f
+ Woodinville, WA | 3 | 3 | f
+ Kenmore, WA | 4 | 3 | f
+ Fremont, WA | 5 | 3 | f
+ Redmond, WA | 2 | 2 | f
+ Mill Creek, WA | 3 | 3 | f
+(15 rows)
+Query with aggregation using HTTP SQL frontend:
+$ curl -s -X POST localhost:8080/api/sql --data-binary @- <<EOF | jq
+SELECT DISTINCT("Landlord"), COUNT("Address")
+FROM properties
+GROUP BY "Landlord"
+EOF
+
+[
+ {
+ "Landlord": "Carl",
+ "COUNT(properties.Address)": 3
+ },
+ {
+ "Landlord": "Roger",
+ "COUNT(properties.Address)": 3
+ },
+ {
+ "Landlord": "Mike",
+ "COUNT(properties.Address)": 4
+ },
+ {
+ "Landlord": "Sam",
+ "COUNT(properties.Address)": 2
+ },
+ {
+ "Landlord": "Daniel",
+ "COUNT(properties.Address)": 3
+ }
+]
+Query with filter using HTTP GraphQL frontend:
+$ curl -s -X POST localhost:8080/api/graphql --data-binary @- <<EOF | jq
+query {
+ properties(
+ filter: {
+ Bed: { gt: 3 }
+ Bath: { gte: 3 }
+ }
+ sort: [
+ { field: "Bed", order: "desc" }
+ ]
+ ) {
+ Address
+ Bed
+ Bath
+ Monthly_Rent
+ }
+}
+EOF
+[
+ {
+ "Address": "Fremont, WA",
+ "Bed": 5,
+ "Bath": 3,
+ "Monthly_Rent": "$4,500"
+ },
+ {
+ "Address": "Kenmore, WA",
+ "Bed": 4,
+ "Bath": 3,
+ "Monthly_Rent": "$4,000"
+ }
+]
+Note: when inferring table schema from Google spreadsheets, ROAPI automatically
+replaces spaces in column names with _(underscore).
NDJSON
+NDJSON stands for Newline delimited JSON. It is a +convenient format for storing or streaming structured data that may be +processed one record at a time.
+When a table uri ends in .ndjson, ROAPI will try to load it as NDJSON table
+if no format option is specified:
tables:
+ - name: "mytable"
+ uri: "http://mytable.ndjson/"
+Delta Lake
+ROAPI supports loading Delta tables from Delta Lake
+through delta-rs. Since a Delta table
+doesn't have an extension suffix, ROAPI cannot infer table format from table
+URI alone. Therefore, the format option needs to be set to delta
+explicitly for Delta table sources:
tables:
+ - name: "mytable"
+ uri: "s3://bucket/delta_table/path"
+ option:
+ format: "delta"
+Large Datasets
+ROAPI loads the entire table into memory as the default behavior. If your
+table is large or you want to avoid loading all data during startup, you can
+set an additional option use_memory_table: false (default: true). With that
+configuration, ROAPI will not copy the data into memory, but instructs datafusion
+to directly operate on the backing storage.
At the moment, this comes with the following limitations:
+-
+
- no nested schema: datafusion#83 +
- missing support for cloud storage: datafusion#616 +
Example:
+tables:
+ - name: "mytable"
+ uri: "./path/to/delta_table"
+ option:
+ format: "delta"
+ use_memory_table: false
+Note that when providing use_memory_table option, it becomes necessary to
+also specify the format.
Arrow
+When a table uri ends in .arrow or .arrows, ROAPI will try to load it as
+Arrow IPC file or stream if no format option is specified:
tables:
+ - name: "mytable"
+ uri: "http://mytable.arrow/" # or .arrows
+You can partition an Arrow dataset into multiple partitions and load all of them +into a single table by directory path:
+tables:
+ - name: "mytable"
+ uri: "./table_dir"
+ option:
+ format: "arrow" # or arrows
+Excel
+ROAPI supports loading Microsoft Excel compatible formats including xls, xlsx, xlsb, and ods files.
+tables:
+ - name: "mytable"
+ uri: "path/to/file.xlsx"
+ option:
+ format: "xlsx"
+ sheet_name: "Sheet1"
+Supported Formats
+-
+
- xls - Microsoft Excel 5.0/95 Workbook +
- xlsx - Excel Workbook +
- xlsb - Excel Binary Workbook +
- ods - OpenDocument Spreadsheet +
Sheet Selection
+You can specify which sheet to load from the spreadsheet using the sheet_name option. By default, ROAPI will use the first sheet if no sheet name is specified.
+
tables:
+ - name: "mytable"
+ uri: "path/to/file.xlsx"
+ option:
+ format: "xlsx"
+ sheet_name: "MyDataSheet"
+Table Range Options
+You can specify a specific range of cells to load from the spreadsheet: +You can specify a specific range of cells to load from the spreadsheet:
+-
+
- rows_range_start - The first row of the table containing column names (default: 0) +
- rows_range_end - The last row of the table (default: all rows) +
- columns_range_start - The first column of the table (default: 0) +
- columns_range_end - The last column of the table (default: all columns) +
tables:
+ - name: "mytable"
+ uri: "path/to/file.xlsx"
+ option:
+ format: "xlsx"
+ sheet_name: "Sheet1"
+ rows_range_start: 1
+ rows_range_end: 4
+ columns_range_start: 1
+ columns_range_end: 3
+Schema Inference
+ROAPI can automatically infer the schema from your Excel data. The first row within the specified range is treated as column names, and ROAPI will analyze the remaining rows to determine data types.
+You can control schema inference with the schema_inference_lines option, which specifies how many rows to analyze (including the header row). For example, schema_inference_lines: 3 will use the first row for column names and analyze 2 additional rows for data types.
If a column contains mixed data types (like both integers and floats), ROAPI will default to the Utf8 (string) data type.
+Explicit Schema Definition
+For better performance and predictable data types, you can define the schema explicitly in your configuration:
+tables:
+ - name: "excel_table"
+ uri: "path/to/file.xlsx"
+ option:
+ format: "xlsx"
+ schema:
+ columns:
+ - name: "int_column"
+ data_type: "Int64"
+ nullable: true
+ - name: "string_column"
+ data_type: "Utf8"
+ nullable: true
+ - name: "float_column"
+ data_type: "Float64"
+ nullable: true
+ - name: "datetime_column"
+ data_type: !Timestamp [Seconds, null]
+ nullable: true
+ - name: "duration_column"
+ data_type: !Duration Second
+ nullable: true
+ - name: "date32_column"
+ data_type: Date32
+ nullable: true
+ - name: "date64_column"
+ data_type: Date64
+ nullable: true
+ - name: "null_column"
+ data_type: Null
+ nullable: true
+Blob store
+ROAPI currently supports the following blob storages:
+-
+
- Filesystem +
- HTTP/HTTPS +
- S3 +
- GCS +
- Azure Storage +
Filesystem
+Filesystem store can be specified using file: or filesystem: schemes. In a
+Windows environment, the scheme is mandatory. On Unix systems, a uri without a
+scheme prefix is treated as filesystem backed data source by ROAPI.
For example, to serve a local parquet file test_data/blogs.parquet, you can
+just set the uri to the file path:
tables:
+ - name: "blogs"
+ uri: "test_data/blogs.parquet"
+Filesystem store supports loading partitioned tables. In other words, you can +split up the table into mulitple files and load all of them into a single table +by setting uri to the directory path. When loading a partitioned dataset, you +will need to manually specify table format since the uri will not contain table +format as a suffix:
+tables:
+ - name: "blogs"
+ uri: "test_data/blogs/"
+ option:
+ format: "parquet"
+HTTP/HTTPS
+ROAPI can build tables from datasets served through HTTP protocols. However, one +thing to keep in mind is HTTP store doesn't support partitioned datasets because +there is no native directory listing support in the HTTP protocol.
+To set custom headers for HTTP requests, you can use the headers io option:
tables:
+ - name: "TABLE_NAME"
+ uri: "http://bucket/TABLE/KEY.csv"
+ io_option:
+ headers:
+ 'Content-Type': 'application/json'
+ Authorization: 'Bearer TOKEN'
+S3
+ROAPI can build tables from datasets hosted in S3 buckets. Configuration is +similar to filesystem store:
+tables:
+ - name: "TABLE_NAME"
+ uri: "s3://BUCKET/TABLE/KEY"
+ option:
+ format: "csv"
+To configure S3 credentials, you can set the following environment variables:
+-
+
AWS_ENDPOINT_URL: The endpoint URL for your S3 provider
+AWS_REGION: The region where your S3 bucket is located
+AWS_SECRET_ACCESS_KEY: The secret access key from your S3 provider
+AWS_ACCESS_KEY_ID: The access key ID from your S3 provider
+
GCS
+ROAPI can build tables from datasets hosted in GCS buckets. Configuration is +similar to filesystem store:
+tables:
+ - name: "TABLE_NAME"
+ uri: "gs://BUCKET/TABLE/KEY"
+ option:
+ format: "csv"
+To configure GCS credentials, you can set the following +environment variables if you are using service accont:
+-
+
GOOGLE_SERVICE_ACCOUNT/GOOGLE_SERVICE_ACCOUNT_PATH: location of service account file
+GOOGLE_SERVICE_ACCOUNT_KEY: JSON serialized service account key
+GOOGLE_APPLICATION_CREDENTIALS: set by gcloud SDK
+- Google Compute Engine Service Account +
- GKE Workload Identity +
Azure Storage
+ROAPI can build tables from datasets hosted in Azure Storage. Configuration is +similar to filesystem store:
+tables:
+ - name: "TABLE_NAME"
+ uri: "az://BUCKET/TABLE/KEY"
+ option:
+ format: "csv"
+The supported url schemas are
+-
+
abfs[s]://<container>/<path>
+az://<container>/<path>
+adl://<container>/<path>
+azure://<container>/<path>
+
To configure Azure credentials, you can set the following +environment variables:
+-
+
AZURE_STORAGE_ACCOUNT_NAME
+AZURE_STORAGE_ACCOUNT_KEY
+AZURE_STORAGE_CLIENT_ID
+AZURE_STORAGE_TENANT_ID
+AZURE_STORAGE_SAS_KEY
+AZURE_STORAGE_TOKEN
+AZURE_MSI_ENDPOINT/AZURE_IDENTITY_ENDPOINT: Endpoint to request a imds managed identity token
+AZURE_OBJECT_ID: Object id for use with managed identity authentication
+AZURE_MSI_RESOURCE_ID: Msi resource id for use with managed identity authentication
+AZURE_FEDERATED_TOKEN_FILE: File containing token for Azure AD workload identity federation
+
Databases
+Thanks to the connector-x Rust crate, +ROAPI is able to load tables from popular relational databases like MySQL, +PostgreSQL and SQLite.
+tables:
+ - name: "table_foo"
+ uri: "mysql://username:password@localhost:3306/database"
+ - name: "table_bar"
+ uri: "mysql://username:password@localhost:3306/database"
+ - name: "table_baz"
+ uri: "sqlite://path/to/sqlitelite/file"
+With this, you can now write a single SQL query to join tables between MySQL, SQLite and local CSV files!
+By default, ROAPI will use the provided table name as the table name to extract
+data from the database. If you want to expose a specific database table with a
+different name, you can use the option field to specify the original table
+name like below:
tables:
+ - name: custom_table_name
+ uri: "sqlite://path/to/sqlitelite/file"
+ option:
+ table: original_table_name
+ format: sqlite
+Postgres wire protocol
+ROAPI uses the convergence Rust +crate to read and write Postgres wire protocol. This means you will be able to +query all tables loaded in ROAPI using any Postgres Clients as if ROAPI is a +real Postgres database!
+By default, ROAPI listens for Postgres traffic on address 127.0.0.1:5432, but
+you can change it using the --addr-postgres command line argument or add the
+following to your config file:
addr:
+ # binding address for TCP port that speaks Postgres wire protocol
+ postgres: 0.0.0.0:5432
+Once ROAPI boots up, you can connect to it without authentication:
+$ psql -h 127.0.0.1
+psql (12.10 (Ubuntu 12.10-0ubuntu0.20.04.1), server 13)
+WARNING: psql major version 12, server major version 13.
+ Some psql features might not work.
+Type "help" for help.
+
+houqp=> select 1;
+ Int64(1)
+----------
+ 1
+(1 row)
+
+houqp=>
+See here for an example on how you can query data stored in a Google spreadsheet using the psql Postgres client.
HTTP API
+Query frontends
+ROAPI exposes a diverse set of interfaces through the HTTP protocol.
+SQL
+To query tables using a subset of standard SQL, send the query payload through
+POST request to /api/sql endpoint. This is the only query interface that
+supports table joins.
SQL query frontend is the more flexible and powerful compared to +REST and GraphQL. It is the only query frontend +that supports table joins.
+SQL frontend supports [""] operator for accessing struct fields and array
+element. For example struct_col["key1"]["key2"] or array_col[0].
REST
+Query tables through REST API by sending GET requests to
+/api/tables/{table_name}. Query operators are specified as query params.
REST query frontend currently supports the following query operators:
+-
+
- columns +
- sort +
- limit +
- filter +
To sort column col1 in ascending order and col2 in descending order, set
+query param to: sort=col1,-col2.
To find all rows with col1 equal to string 'foo', set query param to:
+filter[col1]='foo'. You can also do basic comparisons with filters, for
+example predicate 0 <= col2 < 5 can be expressed as
+filter[col2]gte=0&filter[col2]lt=5.
GraphQL
+To query tables through GraphQL, send the query through POST request to
+/api/graphql endpoint.
GraphQL query frontend supports the same set of operators supported by REST +query frontend. Here how is you can apply various operators in a query:
+{
+ table_name(
+ filter: {
+ col1: false
+ col2: { gteq: 4, lt: 1000 }
+ }
+ sort: [
+ { field: "col2", order: "desc" }
+ { field: "col3" }
+ ]
+ limit: 100
+ ) {
+ col1
+ col2
+ col3
+ }
+}
+Key value lookup
+Query key value stores through REST API by sending GET requests to
+/api/kv/{kv_name}/{key}.
For example, the kvstore defined in the sample +config can be queried like below:
+$ curl -v localhost:8080/api/kv/spacex_launch_name/600f9a8d8f798e2a4d5f979e
+Starlink-21 (v1.0)%
+Schema
+Get schemas for all tables:
+curl localhost:8080/api/schema
+Get schema for a specific table by name:
+curl localhost:8080/api/schema/{TABLE_NAME}
+Response serialization
+By default, ROAPI encodes responses in JSON format, but you can request
+different encodings by specifying the ACCEPT header:
curl -X POST \
+ -H 'ACCEPT: application/vnd.apache.arrow.stream' \
+ -d "SELECT launch_library_id FROM spacex_launches WHERE launch_library_id IS NOT NULL" \
+ localhost:8080/api/sql
+ROAPI currently supports the following serialization formats:
+-
+
application/json
+application/csv
+application/vnd.apache.arrow.file
+application/vnd.apache.arrow.stream
+application/parquet
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/searcher.js b/searcher.js
new file mode 100644
index 0000000..dc03e0a
--- /dev/null
+++ b/searcher.js
@@ -0,0 +1,483 @@
+"use strict";
+window.search = window.search || {};
+(function search(search) {
+ // Search functionality
+ //
+ // You can use !hasFocus() to prevent keyhandling in your key
+ // event handlers while the user is typing their search.
+
+ if (!Mark || !elasticlunr) {
+ return;
+ }
+
+ //IE 11 Compatibility from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith
+ if (!String.prototype.startsWith) {
+ String.prototype.startsWith = function(search, pos) {
+ return this.substr(!pos || pos < 0 ? 0 : +pos, search.length) === search;
+ };
+ }
+
+ var search_wrap = document.getElementById('search-wrapper'),
+ searchbar = document.getElementById('searchbar'),
+ searchbar_outer = document.getElementById('searchbar-outer'),
+ searchresults = document.getElementById('searchresults'),
+ searchresults_outer = document.getElementById('searchresults-outer'),
+ searchresults_header = document.getElementById('searchresults-header'),
+ searchicon = document.getElementById('search-toggle'),
+ content = document.getElementById('content'),
+
+ searchindex = null,
+ doc_urls = [],
+ results_options = {
+ teaser_word_count: 30,
+ limit_results: 30,
+ },
+ search_options = {
+ bool: "AND",
+ expand: true,
+ fields: {
+ title: {boost: 1},
+ body: {boost: 1},
+ breadcrumbs: {boost: 0}
+ }
+ },
+ mark_exclude = [],
+ marker = new Mark(content),
+ current_searchterm = "",
+ URL_SEARCH_PARAM = 'search',
+ URL_MARK_PARAM = 'highlight',
+ teaser_count = 0,
+
+ SEARCH_HOTKEY_KEYCODE = 83,
+ ESCAPE_KEYCODE = 27,
+ DOWN_KEYCODE = 40,
+ UP_KEYCODE = 38,
+ SELECT_KEYCODE = 13;
+
+ function hasFocus() {
+ return searchbar === document.activeElement;
+ }
+
+ function removeChildren(elem) {
+ while (elem.firstChild) {
+ elem.removeChild(elem.firstChild);
+ }
+ }
+
+ // Helper to parse a url into its building blocks.
+ function parseURL(url) {
+ var a = document.createElement('a');
+ a.href = url;
+ return {
+ source: url,
+ protocol: a.protocol.replace(':',''),
+ host: a.hostname,
+ port: a.port,
+ params: (function(){
+ var ret = {};
+ var seg = a.search.replace(/^\?/,'').split('&');
+ var len = seg.length, i = 0, s;
+ for (;i
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Quick start
+Spin up APIs for test_data/uk_cities_with_headers.csv and
+test_data/spacex-launches.json:
roapi \
+ --table "uk_cities=test_data/uk_cities_with_headers.csv" \
+ --table "test_data/spacex_launches.json"
+Or using prebuilt docker image:
+docker run -t --rm -p 8080:8080 ghcr.io/roapi/roapi:latest --addr-http 0.0.0.0:8080 \
+ --table "uk_cities=test_data/uk_cities_with_headers.csv" \
+ --table "test_data/spacex_launches.json"
+Query API
+Query tables using SQL, GraphQL or REST:
+curl -X POST -d "SELECT city, lat, lng FROM uk_cities LIMIT 2" localhost:8080/api/sql
+curl -X POST -d "query { uk_cities(limit: 2) {city, lat, lng} }" localhost:8080/api/graphql
+curl "localhost:8080/api/tables/uk_cities?columns=city,lat,lng&limit=2"
+Sample response:
+[
+ {
+ "city": "Elgin, Scotland, the UK",
+ "lat": 57.653484,
+ "lng": -3.335724
+ },
+ {
+ "city": "Stoke-on-Trent, Staffordshire, the UK",
+ "lat": 53.002666,
+ "lng": -2.179404
+ }
+]
+See Query frontends for details on different operators supported +by each frontend.
+Schema API
+Get inferred schema for all tables:
+curl localhost:8080/api/schema
+Sample response:
+{
+ "uk_cities": {
+ "fields": [
+ {
+ "name": "city",
+ "data_type": "Utf8",
+ "nullable": false,
+ "dict_id": 0,
+ "dict_is_ordered": false
+ },
+ {
+ "name": "lat",
+ "data_type": "Float64",
+ "nullable": false,
+ "dict_id": 0,
+ "dict_is_ordered": false
+ },
+ {
+ "name": "lng",
+ "data_type": "Float64",
+ "nullable": false,
+ "dict_id": 0,
+ "dict_is_ordered": false
+ }
+ ]
+ }
+}
+