[doc][db] Update required files

- data model is the most basic one
- read/write path give general overiew of what happens
- query language and query execution is something full fledged database
should have (not the case for all the tsdb though)
- storage engine, actually it's two parts, data and index for tags
- distributed, a lot of tsdb are distributed (in some way ...)

Author: at15

.travis.yml

@@ -8,16 +8,10 @@ git:
 # TODO: use docker service to start influxdb etc. and create database like oltpbench
 # https://github.com/benchhub/oltpbench/blob/config/cleanup-v2/.travis.yml
 go:
-  - 1.9.x
-  - "1.10"
   - tip
 
 install:
-  - go get -u github.com/golang/dep/cmd/dep
-  - dep version
-  - dep ensure
-  - pwd
+  - go version
 
 script:
-#  - make install
-  - make test
+  - go version

Gopkg.lock

@@ -1,20 +1,35 @@
 # Databases
 
+This folder contains notes on implementation of TSDBs.
+They should be merged into [awesome-time-series-database](https://github.com/xephonhq/awesome-time-series-database) eventually.
+
 Required list in readme
 
-- status: active|dead
-- repo: https://github.com/some/tsdb
-- website: https://some.tsdb.com
-- company: The TSDB Corp.
+- link to [awesome tsdb](https://github.com/xephonhq/awesome-time-series-database), which should contains all the basic meta
+- link to required files within the folder
+- a short overview
+- a key take way from this database
+
+Required files for describing each database. 
+
+Internal
+
+- **data-model.md** General data model, what is a time series for this TSDB (yeah, this definition varies).
+- **write.md** Write path, link to source w/ commit hash.
+- **protocol.md** Wire protocol format and transport, mainly about write because many TSDB have dedicated query language.
+- **read.md** Read path, link to source w/ commit hash.
+- **query-language.md** Query language.
+- **query-execution.md** Query execution and optimization, especially for distributed ones.
+- **storage-engine.md** Only applies to TSDB w/ their own storage format, i.e. write opaque blob to local fs or object store.
+- **schema.md** Only applies to TSDB w/ underlying database i.e. Cassandra, ElasticSearch
+- **distributed.md** Only applies to distributed TSDB, replication model, consensus protocol. Including those built on top of distributed data store i.e. Cassandra, S3.
 
-Required files for describing each databases, they will be merged into [awesome-time-series-database](https://github.com/xephonhq/awesome-time-series-database) eventually
+Operation
 
-- **build.md** how to build it from source locally
-- **docker.md** how to run it using docker(-compose)
-- **config.md** config file example, how to config the system (underlying database, operating system) properly
-- **schema.md** schema for underlying database (i.e. Cassandra, ElasticSearch) if there is any
-- **write-path.md** how data is write into the database, link to source code file if possible
-- **read-path.md** 
+- **build.md** How to build from source locally
+- **docker.md** How to run it using docker(-compose) locally
+- **config.md** Config file example, how to config the system (underlying database, operating system) properly
+- **k8s.md** How to run it on k8s, operator and special things about their operator e.g. local volume
 
 ## TODO
 

Gopkg.toml

@@ -0,0 +1 @@
+# Read path for InfluxDB

doc/database/README.md

@@ -1,4 +1,4 @@
-# Write Path
+# Write path for InfluxDB
 
 Based on original notes from Xephon-K
 

doc/database/influxdb/read.md

@@ -0,0 +1,7 @@
+# Design
+
+## TODO
+
+- [ ] [data model](data-model.md)
+- [ ] [protocol](protocol.md)
+- [ ] [query language](query-language.md)

doc/database/influxdb/write-path.md doc/database/influxdb/write.md

@@ -0,0 +1 @@
+# Data model

doc/design/README.md

@@ -0,0 +1 @@
+# Protocol

doc/design/data-model.md

@@ -0,0 +1,2 @@
+# Query Language
+

doc/design/protocol.md

@@ -0,0 +1,3 @@
+# Survey on metrics collectors
+
+This folder contains survey on metrics collectors that supports multiple tsdb, which is no longer the goal of libtsdb-go.