aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/influxdata/influxdb/models/consistency.go
blob: 2a3269bca11b8d5d8f2a73a4701506311cb9693b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package models

import (
    "errors"
    "strings"
)

// ConsistencyLevel represent a required replication criteria before a write can
// be returned as successful.
//
// The consistency level is handled in open-source InfluxDB but only applicable to clusters.
type ConsistencyLevel int

const (
    // ConsistencyLevelAny allows for hinted handoff, potentially no write happened yet.
    ConsistencyLevelAny ConsistencyLevel = iota

    // ConsistencyLevelOne requires at least one data node acknowledged a write.
    ConsistencyLevelOne

    // ConsistencyLevelQuorum requires a quorum of data nodes to acknowledge a write.
    ConsistencyLevelQuorum

    // ConsistencyLevelAll requires all data nodes to acknowledge a write.
    ConsistencyLevelAll
)

var (
    // ErrInvalidConsistencyLevel is returned when parsing the string version
    // of a consistency level.
    ErrInvalidConsistencyLevel = errors.New("invalid consistency level")
)

// ParseConsistencyLevel converts a consistency level string to the corresponding ConsistencyLevel const.
func ParseConsistencyLevel(level string) (ConsistencyLevel, error) {
    switch strings.ToLower(level) {
    case "any":
        return ConsistencyLevelAny, nil
    case "one":
        return ConsistencyLevelOne, nil
    case "quorum":
        return ConsistencyLevelQuorum, nil
    case "all":
        return ConsistencyLevelAll, nil
    default:
        return 0, ErrInvalidConsistencyLevel
    }
}