Getting started: net.box

Author: andreyaksenov

doc/code_snippets/snippets/connectors/instances.enabled/net_box/README.md

@@ -0,0 +1,12 @@
+# net.box
+
+A sample application used to demonstrate the `net.box` API.
+
+
+## Running
+
+Start the application by executing the following command in the [connectors](../../../connectors) directory:
+
+```console
+$ tt start net_box
+```

doc/code_snippets/snippets/connectors/instances.enabled/net_box/config.yaml

@@ -0,0 +1,10 @@
+groups:
+  group001:
+    replicasets:
+      replicaset001:
+        instances:
+          instance001:
+            iproto: {}
+
+app:
+  file: 'myapp.lua'

doc/code_snippets/snippets/connectors/instances.enabled/net_box/instances.yml

@@ -0,0 +1 @@
+instance001:

doc/code_snippets/snippets/connectors/instances.enabled/net_box/myapp.lua

@@ -0,0 +1,66 @@
+function net_box_session()
+    local net_box = require('net.box')
+    local conn = net_box.connect('sampleuser:[email protected]:3301')
+    conn:ping()
+
+    conn.space.bands:insert { 1, 'Roxette', 1986 }
+    conn.space.bands:insert { 2, 'Scorpions', 1965 }
+    conn.space.bands:insert { 3, 'Ace of Base', 1987 }
+    conn.space.bands:insert { 4, 'The Beatles', 1960 }
+    --[[
+    ---
+    ...
+    ]]
+
+    conn.space.bands:select(1)
+    --[[
+    ---
+    - - [1, 'Roxette', 1986]
+    ...
+    ]]
+
+    conn.space.bands.index.band:select('The Beatles')
+    --[[
+    ---
+    - - [4, 'The Beatles', 1960]
+    ...
+    ]]
+
+    conn.space.bands:update({ 2 }, { { '=', 2, 'Pink Floyd' } })
+    --[[
+    ---
+    - [2, 'Pink Floyd', 1965]
+    ...
+    ]]
+
+    conn.space.bands:upsert({ 5, 'The Rolling Stones', 1962 }, { { '=', 2, 'The Doors' } })
+    --[[
+    ---
+    ...
+    ]]
+
+    conn.space.bands:replace { 1, 'Queen', 1970 }
+    --[[
+    ---
+    - [1, 'Queen', 1970]
+    ...
+    ]]
+
+    conn.space.bands:delete(5)
+    --[[
+    ---
+    - [5, 'The Rolling Stones', 1962]
+    ...
+    ]]
+
+    conn:call('get_bands_older_than', { 1966 })
+    -- ---
+    -- - [[2, 'Pink Floyd', 1965], [4, 'The Beatles', 1960]]
+    -- ...
+
+    conn:close()
+    --[[
+    ---
+    ...
+    ]]
+end

doc/code_snippets/snippets/connectors/instances.enabled/sample_db/README.md

@@ -0,0 +1,11 @@
+# Connectors
+
+A sample application used to demonstrate how to connect to a database using connectors for different languages and execute requests for manipulating the data.
+
+## Running
+
+Start the application by executing the following command in the [connectors](../../../connectors) directory:
+
+```console
+$ tt start sample_db
+```

doc/code_snippets/snippets/connectors/instances.enabled/sample_db/config.yaml

@@ -0,0 +1,22 @@
+credentials:
+  users:
+    sampleuser:
+      password: '123456'
+      privileges:
+      - permissions: [ read, write ]
+        spaces: [ bands ]
+      - permissions: [ execute ]
+        functions: [ get_bands_older_than ]
+
+groups:
+  group001:
+    replicasets:
+      replicaset001:
+        instances:
+          instance001:
+            iproto:
+              listen:
+              - uri: '127.0.0.1:3301'
+
+app:
+  file: 'myapp.lua'

doc/code_snippets/snippets/connectors/instances.enabled/sample_db/instances.yml

@@ -0,0 +1 @@
+instance001:

doc/code_snippets/snippets/connectors/instances.enabled/sample_db/myapp.lua

@@ -0,0 +1,24 @@
+-- Create a space --
+box.schema.space.create('bands')
+
+-- Specify field names and types --
+box.space.bands:format({
+    { name = 'id', type = 'unsigned' },
+    { name = 'band_name', type = 'string' },
+    { name = 'year', type = 'unsigned' }
+})
+
+-- Create indexes --
+box.space.bands:create_index('primary', { parts = { 'id' } })
+box.space.bands:create_index('band', { parts = { 'band_name' } })
+box.space.bands:create_index('year', { parts = { { 'year' } }, unique = false })
+box.space.bands:create_index('year_band', { parts = { { 'year' }, { 'band_name' } } })
+
+-- Create a stored function --
+box.schema.func.create('get_bands_older_than', {
+    body = [[
+    function(year)
+        return box.space.bands.index.year:select({ year }, { iterator = 'LT', limit = 10 })
+    end
+    ]]
+})

doc/code_snippets/snippets/connectors/tt.yaml

@@ -0,0 +1,54 @@
+modules:
+  # Directory where the external modules are stored.
+  directory: modules
+
+env:
+  # Restart instance on failure.
+  restart_on_failure: false
+
+  # Directory that stores binary files.
+  bin_dir: bin
+
+  # Directory that stores Tarantool header files.
+  inc_dir: include
+
+  # Path to directory that stores all applications.
+  # The directory can also contain symbolic links to applications.
+  instances_enabled: instances.enabled
+
+  # Tarantoolctl artifacts layout compatibility: if set to true tt will not create application
+  # sub-directories for control socket, pid files, log files, etc.. Data files (wal, vinyl,
+  # snap) and multi-instance applications are not affected by this option.
+  tarantoolctl_layout: false
+
+app:
+  # Directory that stores various instance runtime
+  # artifacts like console socket, PID file, etc.
+  run_dir: var/run
+
+  # Directory that stores log files.
+  log_dir: var/log
+
+  # Directory where write-ahead log (.xlog) files are stored.
+  wal_dir: var/lib
+
+  # Directory where memtx stores snapshot (.snap) files.
+  memtx_dir: var/lib
+
+  # Directory where vinyl files or subdirectories will be stored.
+  vinyl_dir: var/lib
+
+# Path to file with credentials for downloading Tarantool Enterprise Edition.
+# credential_path: /path/to/file
+ee:
+  credential_path: 
+
+templates:
+  # The path to templates search directory.
+  - path: templates
+
+repo:
+  # Directory where local rocks files could be found.
+  rocks: 
+  # Directory that stores installation files.
+  distfiles: distfiles