Skip to content
Snippets Groups Projects
  • Alexander Turenko's avatar
    55bdb42d
    doc: add contributing guide · 55bdb42d
    Alexander Turenko authored
    GitHub suggests to look on the document, when it is present. The banner
    is shown for visitors of issues and pull requests pages. We can use this
    feature to highlight typical stones on the contributor's road.
    
    My goal is to leave suggestions for typical points of a confusion in a
    short document (don't bury into details) and leave links for further
    reading.
    
    I hope we should move most of content of the 'open a pull request'
    section to a wiki page and possibly merge it with [1] and [2]. It
    requires more work and I would consider it as a future step toward good
    developer guidelines.
    
    [1]: https://github.com/tarantool/tarantool/wiki/Code-review-procedure
    [2]: https://www.tarantool.io/en/doc/latest/dev_guide/developer_guidelines
    
    NO_CHANGELOG=not a user visible change
    NO_DOC=nothing requires an update on the website
    NO_TEST=it is purely documentation change
    55bdb42d
    History
    doc: add contributing guide
    Alexander Turenko authored
    GitHub suggests to look on the document, when it is present. The banner
    is shown for visitors of issues and pull requests pages. We can use this
    feature to highlight typical stones on the contributor's road.
    
    My goal is to leave suggestions for typical points of a confusion in a
    short document (don't bury into details) and leave links for further
    reading.
    
    I hope we should move most of content of the 'open a pull request'
    section to a wiki page and possibly merge it with [1] and [2]. It
    requires more work and I would consider it as a future step toward good
    developer guidelines.
    
    [1]: https://github.com/tarantool/tarantool/wiki/Code-review-procedure
    [2]: https://www.tarantool.io/en/doc/latest/dev_guide/developer_guidelines
    
    NO_CHANGELOG=not a user visible change
    NO_DOC=nothing requires an update on the website
    NO_TEST=it is purely documentation change
README.md 3.88 KiB

Tarantool

Actions Status Code Coverage Telegram GitHub Discussions Stack Overflow

Tarantool is an in-memory computing platform consisting of a database and an application server.

It is distributed under BSD 2-Clause terms.

Key features of the application server:

Key features of the database:

  • MessagePack data format and MessagePack based client-server protocol.
  • Two data engines: 100% in-memory with complete WAL-based persistence and an own implementation of LSM-tree, to use with large data sets.
  • Multiple index types: HASH, TREE, RTREE, BITSET.
  • Document oriented JSON path indexes.
  • Asynchronous master-master replication.
  • Synchronous quorum-based replication.
  • RAFT-based automatic leader election for the single-leader configuration.
  • Authentication and access control.
  • ANSI SQL, including views, joins, referential and check constraints.
  • Connectors for many programming languages.
  • The database is a C extension of the application server and can be turned off.

Supported platforms are Linux (x86_64, aarch64), Mac OS X (x86_64, M1), FreeBSD (x86_64).

Tarantool is ideal for data-enriched components of scalable Web architecture: queue servers, caches, stateful Web applications.

To download and install Tarantool as a binary package for your OS or using Docker, please see the download instructions.

To build Tarantool from source, see detailed instructions in the Tarantool documentation.

To find modules, connectors and tools for Tarantool, check out our Awesome Tarantool list.

Please report bugs to our issue tracker. We also warmly welcome your feedback on the discussions page and questions on Stack Overflow.

We accept contributions via pull requests. Check out our contributing guide.

Thank you for your interest in Tarantool!