Skip to content
Snippets Groups Projects
  • Alexander Turenko's avatar
    b72a5c6a
    readme: actualize without much changes · b72a5c6a
    Alexander Turenko authored
    Well, the diff is not nice, so I'll summarize the changes for humans.
    
    General changes:
    
    * Moved patch submission and so on to the end of the document.
    * Reformatted to usual 80 columns, inlined and actualized links.
    * Reformatted lists: start from a capital letter, end with a period.
    * Minor wording tweaks to make it sound better.
    
    Badges:
    
    * Travis CI and GitLab CI -> GitHub Actions.
    * Removed Slack and Gitter.
    * Google Groups -> GitHub Discussions.
    * Added Stack Overflow.
    
    Define Tarantool as in-memory computing platform as on the website.
    
    Added license information.
    
    Appserver:
    
    * Rewrote the sentence regarding compatibility with Lua 5.1 and
      highlighted key LuaJIT features instead. There are doubts within the
      team about declaring 100% compatibility with Lua 5.1, let's go to the
      safe ground so.
    * Splitted the list in a more granular way.
    * Added links to mysql and pg connectors.
    * Added queue, vshard, cartridge with links.
    * Added a link to the modules page.
    
    Database:
    
    * Replaced MsgPack with MessagePack. It is called so on the official
      website.
    * Replaced 'optional persistence' with 'complete WAL-based persistence'
      in the memtx description to make it less confusing. There are users,
      which believe that memtx does not offer persistency.
    * Moved SQL down.
    * Added JSON path indexes.
    * Added synchronous quorum-based replication.
    * Added RAFT-based automatic leader election.
    * Added a link to the connectors list.
    
    Platforms:
    
    * Dropped OpenBSD from the list. It is not verified in CI, so I feel it
      like 'we have no commitments here'.
    * Replaced x86 with more explicit x86_64.
    * Moved Mac OS before FreeBSD (we have more users here).
    * Added aarch64/M1.
    
    Tarantool is ideal for...
    
    * Kept intact, just reformatted to 80 columns.
    
    Download:
    
    * Added 'or using Docker' in addition to 'as a binary package to your
      OS'.
    
    Added a link to the 'Awesome Tarantool' list.
    
    Report bugs / send feedback or patch:
    
    * Replaced Google Groups with GitHub Discussions.
    * Added Stack Overflow.
    * Highlighted that we accept pull requests and linked 'How to get
      involved' guide.
    
    Fixes #6579
    b72a5c6a
    History
    readme: actualize without much changes
    Alexander Turenko authored
    Well, the diff is not nice, so I'll summarize the changes for humans.
    
    General changes:
    
    * Moved patch submission and so on to the end of the document.
    * Reformatted to usual 80 columns, inlined and actualized links.
    * Reformatted lists: start from a capital letter, end with a period.
    * Minor wording tweaks to make it sound better.
    
    Badges:
    
    * Travis CI and GitLab CI -> GitHub Actions.
    * Removed Slack and Gitter.
    * Google Groups -> GitHub Discussions.
    * Added Stack Overflow.
    
    Define Tarantool as in-memory computing platform as on the website.
    
    Added license information.
    
    Appserver:
    
    * Rewrote the sentence regarding compatibility with Lua 5.1 and
      highlighted key LuaJIT features instead. There are doubts within the
      team about declaring 100% compatibility with Lua 5.1, let's go to the
      safe ground so.
    * Splitted the list in a more granular way.
    * Added links to mysql and pg connectors.
    * Added queue, vshard, cartridge with links.
    * Added a link to the modules page.
    
    Database:
    
    * Replaced MsgPack with MessagePack. It is called so on the official
      website.
    * Replaced 'optional persistence' with 'complete WAL-based persistence'
      in the memtx description to make it less confusing. There are users,
      which believe that memtx does not offer persistency.
    * Moved SQL down.
    * Added JSON path indexes.
    * Added synchronous quorum-based replication.
    * Added RAFT-based automatic leader election.
    * Added a link to the connectors list.
    
    Platforms:
    
    * Dropped OpenBSD from the list. It is not verified in CI, so I feel it
      like 'we have no commitments here'.
    * Replaced x86 with more explicit x86_64.
    * Moved Mac OS before FreeBSD (we have more users here).
    * Added aarch64/M1.
    
    Tarantool is ideal for...
    
    * Kept intact, just reformatted to 80 columns.
    
    Download:
    
    * Added 'or using Docker' in addition to 'as a binary package to your
      OS'.
    
    Added a link to the 'Awesome Tarantool' list.
    
    Report bugs / send feedback or patch:
    
    * Replaced Google Groups with GitHub Discussions.
    * Added Stack Overflow.
    * Highlighted that we accept pull requests and linked 'How to get
      involved' guide.
    
    Fixes #6579
README.md 3.94 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 How to get involved guide.

Thank you for your interest in Tarantool!