Categorygithub.com/distributedio/titan
modulepackage
0.6.0
Repository: https://github.com/distributedio/titan.git
Documentation: pkg.go.dev

# README

Titan

Build Status Go Report Card Coverage Status Coverage Status Discourse status

A distributed implementation of Redis compatible layer based on TiKV

Why Titan?

  • Completely compatible with redis protocol
  • Full distributed transaction with strong consistency
  • Multi-tenancy support
  • No painful scale out
  • High availability

Thanks TiKV for supporting the core features. The project is developed and open sourced by the Beijing Infrastructure Team at Meitu and has been donated to DistributedIO org.

Architecture

titan

Quick start

Can't wait to experiment Titan? Just follow 2 steps:

  1. curl -s -O https://raw.githubusercontent.com/distributedio/titan/master/docker-compose.yml
  2. docker-compose up

Then connect to titan use redis-cli

redis-cli -p 7369

Enjoy!

Installation

SetUp TiKV cluster

Titan works with 2 tidb components:

  • TiKV
  • Pd

To setup TiKV and PD, please follow official instruction

Run Titan

  • Build the binary
go get github.com/distributedio/titan
cd $GOPATH/src/github.com/distributedio/titan
make 
  • Edit the configration file
pd-addrs="tikv://your-pd-addrs:port"
  • Run titan
./titan

For more details about Deploy Titan, click here.

Benchmarks

Refer to the benchmark docs for more details. It is shared on Baidu Disks, use the code hzt6 to gain the permission.

Basic benchmarking result.

Get

Get command benchmark

Set

Set command benchmark

For more info, please vist here Titan Benchmarks

Commands supporting status

For fully supported command list vist here

commandstatus
ConnectionsWon't Fully Supported
TransactionsSupported
ServerNot Fully Supported Yet
KeysSupported
StringsNot Fully Supported Yet
ListNot Fully Supported Yet
HashesSupported
SetsNot Fully Supported Yet
Sorted SetsNot Fully Supported Yet
GeoNot Supported Yet
HyperloglogNot Supported Yet
Pub/SubNot Supported Yet
ScriptingNot Supported Yet
StreamsNot Supported Yet

FAQ

FAQ

Roadmap

View our Roadmap

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

GenerateTraceID grenerates a traceid for once a request.
GetClientID starts with 1 and allocates clientID incrementally.
New a server instance.
PrintVersionInfo prints the server version info.

# Structs

Server implements the redis prototol server.