Contributor’s Guide /
Build and contribute
- Overview
- Getting started
- User’s Guide
- Preface
- Database
- Tarantool Cartridge
- Overview
- Developer’s guide
- Introduction
- Installing Tarantool Cartridge
- Creating a project
- Cluster roles
- Using the built-in HTTP server
- Implementing authorization in the web interface
- Application versioning
- Using .cartridge.ignore files
- Failover architecture
- Configuring instances
- Deploying an application
- Starting/stopping instances
- Error handling guidelines
- Administrator’s guide
- Troubleshooting
- Cartridge API
- Module cartridge
- Module cartridge.auth
- Module cartridge.roles
- Module cartridge.issues
- Module cartridge.argparse
- Module cartridge.twophase
- Module cartridge.failover
- Module cartridge.topology
- Module cartridge.clusterwide-config
- Module cartridge.rpc
- Module cartridge.tar
- Module cartridge.pool
- Module cartridge.confapplier
- Module cartridge.test-helpers
- Module cartridge.remote-control
- Module cartridge.service-registry
- Module custom-role
- Module cartridge.lua-api.stat
- Module cartridge.lua-api.boxinfo
- Module cartridge.lua-api.get-topology
- Module cartridge.lua-api.edit-topology
- Module cartridge.lua-api.topology
- Module cartridge.lua-api.failover
- Module cartridge.lua-api.vshard
- Module cartridge.lua-api.deprecated
- Class cartridge.test-helpers.cluster
- Class cartridge.test-helpers.server
- Class cartridge.test-helpers.etcd
- Cartridge CLI
- Changelog
- [Unreleased]
- [2.3.0] - 2020-08-26
- [2.2.0] - 2020-06-23
- [2.1.2] - 2020-04-24
- [2.1.1] - 2020-04-20
- [2.1.0] - 2020-04-16
- [2.0.2] - 2020-03-17
- [2.0.1] - 2020-01-15
- [2.0.0] - 2019-12-27
- [1.2.0] - 2019-10-21
- [1.1.0] - 2019-09-24
- [1.0.0] - 2019-08-29
- [0.10.0] - 2019-08-01
- [0.9.2] - 2019-07-12
- [0.9.1] - 2019-07-10
- [0.9.0] - 2019-07-02
- [0.8.0] - 2019-05-20
- [0.7.0] - 2019-04-05
- [0.6.3] - 2019-02-08
- [0.6.2] - 2019-02-07
- [0.6.1] - 2019-02-05
- [0.6.0] - 2019-01-30
- [0.5.1] - 2018-12-12
- [0.5.0] - 2018-12-11
- [0.4.0] - 2018-11-27
- [0.3] - 2018-10-30
- [0.2] - 2018-10-01
- [0.1] - 2018-09-25
- Application server
- Launching an application
- Creating an application
- Installing a module
- Contributing a module
- Reloading a module
- Developing with an IDE
- Cookbook recipes
- hello_world.lua
- console_start.lua
- fio_read.lua
- fio_write.lua
- ffi_printf.lua
- ffi_gettimeofday.lua
- ffi_zlib.lua
- ffi_meta.lua
- ffi_varbinary_insert.lua
- print_arrays.lua
- count_array.lua
- count_array_with_nils.lua
- count_array_with_nulls.lua
- count_map.lua
- swap.lua
- class.lua
- garbage.lua
- fiber_producer_and_consumer.lua
- socket_tcpconnect.lua
- socket_tcp_echo.lua
- getaddrinfo.lua
- socket_udp_echo.lua
- http_get.lua
- http_send.lua
- http_server.lua
- http_generate_html.lua
- Server administration
- Instance configuration
- Starting/stopping an instance
- Logs
- Security
- Server introspection
- Daemon supervision
- Disaster recovery
- Backups
- Upgrades
- Notes for operating systems
- Bug reports
- Troubleshooting guide
- Problem: INSERT/UPDATE-requests result in ER_MEMORY_ISSUE error
- Problem: Tarantool generates too heavy CPU load
- Problem: Query processing times out
- Problem: Replication “lag” and “idle” contain negative values
- Problem: Replication “idle” keeps growing, but no related log messages appear
- Problem: Replication statistics differ on replicas within a replica set
- Problem: Master-master replication is stopped
- Problem: Tarantool works much slower than before
- Replication
- Monitoring
- Connectors
- SQL
- FAQ
- Reference
- SQL reference
- SQL beginners’ guide
- SQL user guide
- SQL statements and clauses
- SQL PLUS LUA – Adding Tarantool/NoSQL to Tarantool/SQL
- Built-in modules reference
- Module box
- Submodule box.backup
- Submodule box.cfg
- Submodule box.ctl
- Submodule box.error
- Submodule box.index
- Submodule box.info
- Function box.once
- Constant box.NULL
- Submodule box.schema
- Submodule box.session
- Submodule box.slab
- Submodule box.space
- Submodule box.stat
- Function box.snapshot
- Submodule box.tuple
- Functions for transaction management
- Functions for SQL
- Module buffer
- Module clock
- Module console
- Module crypto
- Module csv
- Module decimal
- Module digest
- Module errno
- Module fiber
- Module fio
- Module fun
- Module http
- Module iconv
- Module json
- Module key_def
- Module log
- Module merger
- 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 uuid
- Module utf8
- Module uri
- Module xlog
- Module yaml
- Other package components
- Database error codes
- Handling errors
- Debug facilities
- JSON paths
- Module box
- Rocks reference
- Configuration reference
- Interactive console
- Utility tarantoolctl
- Tips on Lua syntax
- SQL reference
- Tutorials
- Lua tutorials
- Insert one million tuples with a Lua stored procedure
- Configure
- Delimiter
- Create a function that returns a string
- Create a function that calls another function and sets a variable
- Modify the function so it returns a one-letter random string
- Modify the function so it returns a ten-letter random string
- Make a tuple out of a number and a string
- Modify main_function to insert a tuple into the database
- Modify main_function to insert a million tuples into the database
- Sum a JSON field for all tuples
- Indexed pattern search
- Insert one million tuples with a Lua stored procedure
- C tutorial
- SQL tutorial
- libslave tutorial
- Lua tutorials
- Release Notes
- Contributor’s Guide
- C API reference
- Internals
- Binary protocol
- Binary protocol – symbols and terms
- Binary protocol – illustration
- Binary protocol – header and body
- Binary protocol – requests
- Binary protocol – responses if no error and no SQL
- Binary protocol – responses for errors
- Binary protocol – responses for SQL
- Binary protocol – authentication
- Binary protocol – replication
- XLOG / SNAP
- MessagePack extensions
- File formats
- The recovery process
- Server startup with replication
- Binary protocol
- Build and contribute
- Guidelines
- Developer guidelines
- Documentation guidelines
- C Style Guide
- General guidelines
- Linux kernel coding style
- Chapter 1: Indentation
- Chapter 2: Breaking long lines and strings
- Chapter 3: Placing Braces and Spaces
- Chapter 3.1: Spaces
- Chapter 4: Naming
- Chapter 5: Typedefs
- Chapter 6: Functions
- Chapter 7: Centralized exiting of functions
- Chapter 8: Commenting
- Chapter 9: You’ve made a mess of it
- Chapter 10: Kconfig configuration files
- Chapter 11: Data structures
- Chapter 12: Macros, Enums and RTL
- Chapter 13: Printing kernel messages
- Chapter 14: Allocating memory
- Chapter 15: The inline disease
- Chapter 16: Function return values and names
- Chapter 17: Don’t re-invent the kernel macros
- Chapter 18: Editor modelines and other cruft
- Appendix I: References
- Python Style Guide
- Lua Style Guide