Skip to content
Snippets Groups Projects
README.md 1.41 KiB
Newer Older
# Picodata – Professional Data Management System for High Loads
Alexander Tolstoy's avatar
Alexander Tolstoy committed
This repository contains the source code of Picodata, an in-memory
database with plugins in Rust.
Sergey V's avatar
Sergey V committed

## What is Picodata
Yaroslav Dynnikov's avatar
Yaroslav Dynnikov committed

Picodata is a software for building professional data management
Alexander Tolstoy's avatar
Alexander Tolstoy committed
systems. It provides an in-memory database together with a development
platform and a runtime for custom plugins written in Rust. Learn more
about our software at the [picodata.io] web site.
Alexander Tolstoy's avatar
Alexander Tolstoy committed
[picodata.io]: https://picodata.io/picodata/
Sergey V's avatar
Sergey V committed

## Getting Picodata
Yaroslav Dynnikov's avatar
Yaroslav Dynnikov committed

We provide pre-built Picodata packages for select Linux distributions
Alexander Tolstoy's avatar
Alexander Tolstoy committed
including CentOS and Ubuntu. Head over to
[picodata.io/download] to see what is available.

[picodata.io/download]: https://picodata.io/download/
Sergey V's avatar
Sergey V committed

## Running Picodata
Yaroslav Dynnikov's avatar
Yaroslav Dynnikov committed

Running a Picodata instance only takes one simple command:

```bash
picodata run
```

Getting a basic distributed cluster made of two instances running on
different hosts involves two commands, like this:
Sergey V's avatar
Sergey V committed

```bash
picodata run --listen 192.168.0.1:3301
Yaroslav Dynnikov's avatar
Yaroslav Dynnikov committed
picodata run --listen 192.168.0.2:3301 --peer 192.168.0.1:3301
Sergey V's avatar
Sergey V committed
```
Yaroslav Dynnikov's avatar
Yaroslav Dynnikov committed

You can find out more about getting started procedures and first steps
Alexander Tolstoy's avatar
Alexander Tolstoy committed
by heading to [docs.picodata.io].
Alexander Tolstoy's avatar
Alexander Tolstoy committed
[docs.picodata.io]: https://docs.picodata.io/picodata/stable/
Sergey V's avatar
Sergey V committed

## Building Picodata from source
Alexander Tolstoy's avatar
Alexander Tolstoy committed
Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) document for more
detailed prerequisites, compilation instructions as well as steps
required to run integration tests.