Influxdata
/
influxdb
mirror of https://github.com/influxdata/influxdb.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README.md

pull/1731/head
Todd Persen 2015-02-24 16:25:29 -08:00
parent 415c5610a6
commit 3fe2029571
1 changed files with 35 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
README.md
View File

@ -1,25 +1,47 @@
InfluxDB [![Build Status](https://travis-ci.org/influxdb/influxdb.png?branch=master)](https://travis-ci.org/influxdb/influxdb)
=========
# InfluxDB [![Build Status](https://travis-ci.org/influxdb/influxdb.png?branch=master)](https://travis-ci.org/influxdb/influxdb)
> NOTE: The master branch of InfluxDB is undergoing a significant refactor for
> v0.9.0. If you need to build a working copy of InfluxDB, please use the
> [`0.8.8`](https://github.com/influxdb/influxdb/releases/tag/v0.8.8) tag.
## An Open-Source, Distributed, Time Series Database
> InfluxDB v0.9.0 is now in the RC phase. If you're building a new project,
> please build against `master` or the most current RC instead of using v0.8.8.
InfluxDB is an open source **distributed time series database** with
**no external dependencies**. It's useful for recording metrics,
events, and performing analytics.
It has a built-in HTTP API so you don't have to write any server side
code to get up and running.
## Features
InfluxDB is designed to be scalable, simple to install and manage, and
fast to get data in and out.
* Built-in HTTP API so you don't have to write any server side code to get up and running.
* Clustering is supported out of the box, so that you can scale horizontally to handle your data.
* Simple to install and manage, and fast to get data in and out.
* It aims to answer queries in real-time. That means every data point is
indexed as it comes in and is immediately available in queries that
should return in < 100ms.
It aims to answer queries in real-time. That means every data point is
indexed as it comes in and is immediately available in queries that
should return in < 100ms.
## Getting Started
## Quickstart
### Building
You don't need to build the project to use it - you can use any of our
[pre-built packages](http://influxdb.com/docs/v0.8/introduction/installation.html) to install InfluxDB. That's
the recommended way to get it running. However, if you want to contribute to the core of InfluxDB, you'll need to build.
For those adventurous enough, you can
[follow along on our docs](http://github.com/influxdb/influxdb/blob/master/CONTRIBUTING.md).
### Creating your first database
```JSON
curl -XGET 'http://localhost:8086/query' --data-urlencode "q=CREATE DATABASE mydb"
```
### Setting up the database's retention policy
```JSON
curl -XGET 'http://localhost:8086/query' --data-urlencode "q=CREATE RETENTION POLICY mypolicy ON mydb REPLICATION 7d DEFAULT"
```
## Helpful Links
* Understand the [design goals and motivations of the project](http://influxdb.com/docs/v0.8/introduction/overview.html).
* Follow the [getting started guide](http://influxdb.com/docs/v0.8/introduction/getting_started.html) to find out how to install InfluxDB, start writing data, and issue queries - in just a few minutes.
@ -28,12 +50,3 @@ should return in < 100ms.
or check out the
[HTTP API documentation to start writing a library for your favorite language](http://influxdb.com/docs/v0.8/api/reading_and_writing_data.html).
## Building
You don't need to build the project to use it. Pre-built
[binaries and instructions to install InfluxDB are here](http://influxdb.com/docs/v0.8/introduction/installation.html). That's
the recommended way to get it running. However, if you want to
contribute to the core of InfluxDB, you'll need to build. For those
adventurous enough, you can
[follow along on our docs](http://github.com/influxdb/influxdb/blob/master/CONTRIBUTING.md).