# README
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.8tag.
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.
InfluxDB is designed to be scalable, 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.
Quickstart
- Understand the design goals and motivations of the project.
- Follow the getting started guide to find out how to install InfluxDB, start writing data, and issue queries - in just a few minutes.
- See the list of libraries for different languages, or check out the HTTP API documentation to start writing a library for your favorite language.
Building
You don't need to build the project to use it. Pre-built binaries and instructions to install InfluxDB are here. 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
# 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
Package influxql implements a parser for the InfluxDB query language.
Package messaging implements a distributed, raft-backed messaging system.
Package raft implements a streaming version of the Raft protocol.
No description provided by the author
# Functions
HashPassword generates a cryptographically secure hash for password.
NewMeasurement allocates and initializes a new Measurement.
NewRetentionPolicy returns a new instance of RetentionPolicy with defaults set.
NewServer returns a new instance of Server.
NewUDPServer returns an instance of UDPServer attached to a Server.
NormalizeBatchPoints returns a slice of Points, created by populating individual points within the batch, which do not have timestamps or tags, with the top-level values.
# Constants
DefaultReplicaN represents the number of replicas data is written to.
DefaultRetentionPolicyName is the name of a databases's default shard space.
DefaultRootPassword is the password initially set for the root user.
DefaultShardDuration is the time period held by a shard.
DefaultShardRetention is the length of time before a shard is dropped.
DefaultSplitN represents the number of partitions a shard is split into.
MicrosecondPrecision is 1/1,000,000 th of a second.
MillisecondPrecision is 1/1,000 th of a second.
SecondPrecision is 1 second precision.
# Variables
BcryptCost is the cost associated with generating password with Bcrypt.
ErrClusterAdminExists is returned when creating a duplicate admin.
ErrClusterAdminNotFound is returned when deleting a non-existent admin.
ErrDatabaseExists is returned when creating a duplicate database.
ErrDatabaseNameRequired is returned when creating a database without a name.
ErrDatabaseNotFound is returned when dropping a non-existent database.
ErrDatabaseRequired is returned when using a blank database name.
ErrDataNodeExists is returned when creating a duplicate data node.
ErrDataNodeNotFound is returned when dropping a non-existent data node.
ErrDataNodeRequired is returned when using a blank data node id.
ErrDataNodeURLRequired is returned when creating a data node without a URL.
ErrDefaultRetentionPolicyNotFound is returned when using the default policy on a database but the default has not been set.
ErrFieldOverflow is returned when too many fields are created on a measurement.
ErrInvalidGrantRevoke is returned when a statement requests an invalid privilege for a user on the cluster or a database.
ErrInvalidQuery is returned when executing an unknown query type.
ErrInvalidUsername is returned when using a username with invalid characters.
ErrMeasurementNameRequired is returned when a point does not contain a name.
ErrMeasurementNotFound is returned when a measurement does not exist.
ErrNotExecuted is returned when a statement is not executed in a query.
ErrPathRequired is returned when opening a server without a path.
ErrReadAccessDenied is returned when a user attempts to read data that he or she does not have permission to read.
ErrReadWritePermissionsRequired is returned when required read/write permissions aren't provided.
ErrRetentionPolicyExists is returned when creating a duplicate shard space.
ErrRetentionPolicyNameRequired is returned using a blank shard space name.
ErrRetentionPolicyNotFound is returned when deleting a non-existent shard space.
ErrSeriesExists is returned when attempting to set the id of a series by database, name and tags that already exists.
ErrSeriesNotFound is returned when looking up a non-existent series by database, name and tags.
ErrServerClosed is returned when closing an already closed server.
ErrServerOpen is returned when opening an already open server.
ErrShardNotFound is returned writing to a non-existent shard.
ErrUnableToJoin is returned when a server cannot join a cluster.
ErrUserExists is returned when creating a duplicate user.
ErrUsernameRequired is returned when using a blank username.
ErrUserNotFound is returned when deleting a non-existent user.
ErrValuesRequired is returned when a point does not any values.
# Structs
BatchPoints is used to send batched data in a single write.
ContinuousQuery represents a query that exists on the server and processes each incoming event.
DataNode represents a data node in the cluster.
ErrAuthorize represents an authorization error.
Field represents a series field.
Matcher can match either a Regex or plain string.
Measurement represents a collection of time series in a database.
Point defines the values that will be written to the database.
Result represents a resultset returned from a single statement.
Results represents a list of statement results.
RetentionPolicy represents a policy for creating new shards in a database and how long they're kept around for.
RetentionPolicyUpdate represents retention policy fields that need to be updated.
Series belong to a Measurement and represent unique time series in a database.
Server represents a collection of metadata and raw metric data.
Shard represents the logical storage for a given time range.
ShardGroup represents a group of shards created for a single time range.
TagFilter represents a tag filter when looking up other tags or measurements.
UDPServer represents a UDP transport for InfluxDB.
User represents a user account on the system.
# Interfaces
MessagingClient represents the client used to receive messages from brokers.
# Type aliases
Fields represents a list of fields.
Measurements represents a list of *Measurement.
SeriesIDs is a convenience type for sorting, checking equality, and doing union and intersection of collections of series ids.
Shards represents a list of shards.
TimePrecision represents a level of time precision.