The translation is temporarily closed for contributions due to maintenance, please come back later.
The translation was automatically locked due to following alerts: Could not merge the repository.
Zen

Source string Source string

588/10000 · 588
English Actions
Installing a module from a repository
See `README in tarantool/rocks repository <https://github.com/tarantool/rocks#managing-modules-with-tarantool-174>`_ for detailed instructions.
Installing a module from deb/rpm
Follow these steps:
Install Tarantool as recommended on the `download page <https://www.tarantool.io/download>`_.
Install the module you need. Look up the module's name on `Tarantool rocks page <https://tarantool.io/rocks.html>`_ and put the prefix "tarantool-" before the module name to avoid ambiguity:
$ # for Ubuntu/Debian:
$ sudo apt-get install tarantool-<module-name>

$ # for RHEL/CentOS/Amazon:
$ sudo yum install tarantool-<module-name>
For example, to install the module `vshard <http://github.com/tarantool/vshard>`_ on Ubuntu, say:
$ sudo apt-get install tarantool-vshard
Once these steps are complete, you can:
load any module with
tarantool> name = require('module-name')
for example:
tarantool> vshard = require('vshard')
search locally for installed modules using ``package.path`` (Lua) or ``package.cpath`` (C):
tarantool> package.path
---
- ./?.lua;./?/init.lua; /usr/local/share/tarantool/?.lua;/usr/local/share/
tarantool/?/init.lua;/usr/share/tarantool/?.lua;/usr/share/tarantool/?/ini
t.lua;/usr/local/share/lua/5.1/?.lua;/usr/local/share/lua/5.1/?/init.lua;/
usr/share/lua/5.1/?.lua;/usr/share/lua/5.1/?/init.lua;
...

tarantool> package.cpath
---
- ./?.so;/usr/local/lib/x86_64-linux-gnu/tarantool/?.so;/usr/lib/x86_64-li
nux-gnu/tarantool/?.so;/usr/local/lib/tarantool/?.so;/usr/local/lib/x86_64
-linux-gnu/lua/5.1/?.so;/usr/lib/x86_64-linux-gnu/lua/5.1/?.so;/usr/local/
lib/lua/5.1/?.so;
...
Question-marks stand for the module name that was specified earlier when saying ``require('module-name')``.
Reloading a module
You can reload any Tarantool application or module with zero downtime.
Reloading a module in Lua
Here's an example that illustrates the most typical case -- "update and reload".
In this example, we use recommended :ref:`administration practices <admin>` based on :ref:`instance files <admin-instance_file>` and :ref:`tt <tt-cli>` utility.
Update the application file.
For example, a module in ``/usr/share/tarantool/app.lua``:
local function start()
-- initial version
box.once("myapp:v1.0", function()
box.schema.space.create("somedata")
box.space.somedata:create_index("primary")
...
end)

-- migration code from 1.0 to 1.1
box.once("myapp:v1.1", function()
box.space.somedata.index.primary:alter(...)
...
end)

-- migration code from 1.1 to 1.2
box.once("myapp:v1.2", function()
box.space.somedata.index.primary:alter(...)
box.space.somedata:insert(...)
...
end)
end

-- start some background fibers if you need

local function stop()
-- stop all background fibers and clean up resources
end

local function api_for_call(xxx)
-- do some business
end

return {
start = start,
stop = stop,
api_for_call = api_for_call
}
Update the :ref:`instance file <admin-instance_file>`.
For example, ``/etc/tarantool/instances.enabled/my_app.lua``:
#!/usr/bin/env tarantool
--
-- hot code reload example
--

box.cfg({listen = 3302})

-- ATTENTION: unload it all properly!
local app = package.loaded['app']
if app ~= nil then
-- stop the old application version
app.stop()
-- unload the application
package.loaded['app'] = nil
-- unload all dependencies
package.loaded['somedep'] = nil
end

-- load the application
log.info('require app')
app = require('app')

-- start the application
app.start({some app options controlled by sysadmins})
The important thing here is to properly unload the application and its dependencies.
Manually reload the application file.
For example, using ``tt``:

Loading…

User avatar None

New source string

testing_project / Documentation: book/admin/modules — English

tarantool> package.path
---
- ./?.lua;./?/init.lua; /usr/local/share/tarantool/?.lua;/usr/local/share/
tarantool/?/init.lua;/usr/share/tarantool/?.lua;/usr/share/tarantool/?/ini
t.lua;/usr/local/share/lua/5.1/?.lua;/usr/local/share/lua/5.1/?/init.lua;/
usr/share/lua/5.1/?.lua;/usr/share/lua/5.1/?/init.lua;
...

tarantool> package.cpath
---
- ./?.so;/usr/local/lib/x86_64-linux-gnu/tarantool/?.so;/usr/lib/x86_64-li
nux-gnu/tarantool/?.so;/usr/local/lib/tarantool/?.so;/usr/local/lib/x86_64
-linux-gnu/lua/5.1/?.so;/usr/lib/x86_64-linux-gnu/lua/5.1/?.so;/usr/local/
lib/lua/5.1/?.so;
...
a year ago
Browse all string changes

Things to check

Ellipsis

The string uses three dots (...) instead of an ellipsis character (…)

Reset

Glossary

English English
No related strings found in the glossary.

String information

Flags
read-only
String age
a year ago
Last updated
a year ago
Source string age
a year ago
Translation file
string 22