Support
All sections
Reference
Configuration reference
Configuration reference (box.cfg)
tarantool command-line options
SQL reference
What Tarantool's SQL product delivers
SQL user guide
SQL statements and clauses
SQL PLUS LUA -- Adding Tarantool/NoSQL to Tarantool/SQL
SQL features
Built-in modules reference
Module box
Submodule box.backup
box.backup.start()
box.backup.stop()
Submodule box.cfg
Submodule box.ctl
box.ctl.wait_ro()
box.ctl.wait_rw()
box.ctl.on_schema_init()
box.ctl.on_shutdown()
box.ctl.on_recovery_state()
box.ctl.on_election()
box.ctl.set_on_shutdown_timeout()
box.ctl.is_recovery_finished()
box.ctl.promote()
box.ctl.demote()
box.ctl.make_bootstrap_leader()
Submodule box.error
box.error()
box.error.last()
box.error.clear()
box.error.new()
box.error.set()
box.error.is()
error_object
Submodule box.index
Examples for `box.index`
index_object.unique
index_object.type
index_object.parts
index_object:pairs()
index_object:select()
index_object:get()
index_object:min()
index_object:max()
index_object:random()
index_object:count()
index_object:update()
index_object:delete()
index_object:alter()
index_object:drop()
index_object:rename()
index_object:bsize()
index_object:stat()
index_object:compact()
index_object:tuple_pos()
index_object extensions
Submodule box.info
box.info()
box.info.cluster
box.info.config
box.info.election
box.info.gc()
box.info.hostname
box.info.id
box.info.listen
box.info.lsn
box.info.memory()
box.info.name
box.info.package
box.info.pid
box.info.replicaset
box.info.replication
box.info.replication_anon()
box.info.ro
box.info.ro_reason
box.info.schema_version
box.info.signature
box.info.sql
box.info.status
box.info.synchro
box.info.uptime
box.info.uuid
box.info.vclock
box.info.version
box.info.vinyl()
Submodule box.iproto
box.iproto.key
box.iproto.type
box.iproto.flag
box.iproto.ballot_key
box.iproto.metadata_key
box.iproto.raft
box.iproto.protocol_version
box.iproto.protocol_features
box.iproto.feature
box.iproto.override()
box.iproto.send()
Submodule box.read_view
box.read_view.list()
box.read_view.open()
Submodule box.schema
box.schema.space.create()
box.schema.upgrade()
box.schema.downgrade()
box.schema.downgrade_versions()
box.schema.downgrade_issues()
box.schema.user.create()
box.schema.user.drop()
box.schema.user.exists()
box.schema.user.grant()
box.schema.user.revoke()
box.schema.user.enable()
box.schema.user.disable()
box.schema.user.password()
box.schema.user.passwd()
box.schema.user.info()
box.schema.role.create()
box.schema.role.drop()
box.schema.role.exists()
box.schema.role.grant()
box.schema.role.revoke()
box.schema.role.info()
box.schema.func.create()
box.schema.func.drop()
box.schema.func.exists()
box.schema.func.reload()
Sequences
box.schema.sequence.create()
sequence_object:next()
sequence_object:alter()
sequence_object:reset()
sequence_object:set()
sequence_object:current()
sequence_object:drop()
specifying a sequence in create_index()
Submodule box.session
box.session.id()
box.session.exists()
box.session.peer()
box.session.sync()
box.session.user()
box.session.type()
box.session.su()
box.session.uid()
box.session.euid()
box.session.storage
box.session.on_connect()
box.session.on_disconnect()
box.session.on_auth()
box.session.on_access_denied()
box.session.push()
Submodule box.slab
box.runtime.info()
box.slab.info()
box.slab.stats()
Submodule box.space
space_object:create_index()
space_object:alter()
space_object:auto_increment()
space_object:bsize()
space_object:count()
space_object:delete()
space_object:drop()
space_object:format()
space_object:frommap()
space_object:get()
space_object:insert()
space_object:len()
space_object:on_replace()
space_object:before_replace()
space_object:pairs()
space_object:put()
space_object:rename()
space_object:replace() / put()
space_object:run_triggers()
space_object:select()
space_object:stat()
space_object:truncate()
space_object:update()
space_object:upsert()
space_object extensions
box.space.create_check_constraint()
space_object:enabled
space_object:field_count
space_object.id
space_object.index
box.space._cluster
box.space._func
box.space._index
box.space._vindex
box.space._priv
box.space._vpriv
box.space._schema
box.space._sequence
box.space._sequence_data
box.space._space
box.space._vspace
box.space._space_sequence
box.space._vspace_sequence
box.space._user
box.space._vuser
box.space._ck_constraint
box.space._collation
box.space._vcollation
System space views
box.space._session_settings
Submodule box.stat
box.stat()
box.stat.net()
box.stat.memtx()
box.stat.vinyl()
box.stat.reset()
Submodule box.tuple
box.tuple.new()
box.tuple.is()
#tuple_object
tuple_object.bsize()
tuple_object[field-number]
tuple_object[field-name]
tuple_object[field-path]
tuple_object:find(), tuple_object:findall()
tuple_object:format()
tuple_object.info()
tuple_object:next()
tuple_object:pairs(), tuple_object:ipairs()
tuple_object:totable()
tuple_object:tomap()
tuple_object:transform()
tuple_object:unpack()
tuple_object:update()
tuple_object:upsert()
Functions for transaction management
box.begin()
box.commit()
box.rollback()
box.savepoint()
box.rollback_to_savepoint()
box.atomic()
box.on_commit()
box.on_rollback()
box.is_in_txn()
Functions for SQL
box.execute()
box.prepare()
object prepared_table
Event watchers
box.watch()
box.watch_once()
box.broadcast()
System events
Function box.once
Function box.snapshot
Constant box.NULL
Module buffer
Module checks
Module clock
Module compat
JSON encode escape forward slash
Lua-YAML prettier multiline output
Fiber channel close mode
Default value for replication_sync_timeout
Default value for sql_seq_scan session setting
Default value for max fiber slice
Decoding binary objects
box.session.push() deprecation
Tutorial: Module compat
Module compress
Submodule compress.zlib
Submodule compress.zstd
Submodule compress.lz4
Module config
Submodule experimental.config.utils.schema
Module console
Module crypto
Module csv
Module datetime
Module decimal
Module digest
Module errno
Module experimental.connpool
Module fiber
Module fio
Module fun
Module http
Module iconv
Module jit
Module json
Module key_def
Module log
Module merger
Module metrics
metrics.plugins.prometheus
metrics.plugins.graphite
metrics.plugins.json
Module msgpack
Module net.box
Module os
Module pickle
Module popen
Module socket
Module strict
Module string
Module swim
Module table
Module tap
Module tarantool
Module uri
Module utf8
Module ulid
Module uuid
Module varbinary
Module xlog
Module yaml
Other package components
Database error codes
Debug facilities
JSON paths
Rocks reference
Module membership
Module vshard
Configuration reference
API Reference
Router API
Storage API
SQL DBMS Modules
Other rocks
C API reference
Module box
Module clock
Module coio
Module error
Module fiber
Module index
Module latch
Function on_shutdown
Module lua/utils
Module say (logging)
Module schema
Module trivia/config
Module tuple
Module txn
Read views: C API
Internals
Binary protocol
Understanding the binary protocol
MP_* MessagePack types
Request and response format
Keys used in requests and responses
Client-server requests and responses
Session start and authentication
Streams
Events and subscriptions
Graceful shutdown protocol
SQL-specific requests and responses
Replication requests and responses
MessagePack extensions
File formats
The recovery process
Replication internals
Server startup with replication
Orphan status
Limitations
Версия 3.x
© 2026 Tarantool
Docs
Reference
Built-in modules reference
Module box
Submodule box.backup
box.backup.stop()
Updated at August 24, 2026 05:21 PM
box.backup.stop()
backup.stop()
Informs the server that normal operations may resume.
Was this article helpful?
Yes
No
Contact support
Add to bookmarks
Was this article helpful?
Yes
No
