mirror of https://github.com/tidwall/tile38.git
updated config summary
This commit is contained in:
Josh Baker
parent
73ea8b8ee4
commit
a1abccc6fd
|
|
@ -24,14 +24,14 @@ this mode connections are only accepted from the loopback interface. If you
|
|||
want to connect from external computers to Tile38 you may adopt one of the
|
||||
following solutions:
|
||||
|
||||
1) Disable protected mode sending the command 'CONFIG SET protected-mode no'
|
||||
1) Disable protected mode by sending the command 'CONFIG SET protected-mode no'
|
||||
from the loopback interface by connecting to Tile38 from the same host
|
||||
the server is running, however MAKE SURE Tile38 is not publicly accessible
|
||||
from internet if you do so. Use CONFIG REWRITE to make this change
|
||||
permanent.
|
||||
2) Alternatively you can just disable the protected mode by editing the Tile38
|
||||
configuration file, and setting the protected mode option to 'no', and then
|
||||
restarting the server.
|
||||
configuration file, and setting the 'protected-mode' option to 'no', and
|
||||
then restarting the server.
|
||||
3) If you started the server manually just for testing, restart it with the
|
||||
'--protected-mode no' option.
|
||||
4) Setup a host address or an authentication password.
|
||||
|
|
|
|||
909
core/commands.go
909
core/commands.go
|
|
@ -1,3 +1,5 @@
|
|||
// +build ignore
|
||||
|
||||
package core
|
||||
|
||||
import (
|
||||
|
|
@ -31,7 +33,13 @@ func (c Command) String() string {
|
|||
}
|
||||
|
||||
func (c Command) TermOutput(indent string) string {
|
||||
line1 := bright + strings.Replace(c.String(), " ", " "+clear+gray, 1) + clear
|
||||
line := c.String()
|
||||
var line1 string
|
||||
if strings.HasPrefix(line, c.Name) {
|
||||
line1 = bright + c.Name + clear + gray + line[len(c.Name):] + clear
|
||||
} else {
|
||||
line1 = bright + strings.Replace(c.String(), " ", " "+clear+gray, 1) + clear
|
||||
}
|
||||
line2 := yellow + "summary: " + clear + c.Summary
|
||||
//line3 := yellow + "since: " + clear + c.Since
|
||||
return indent + line1 + "\n" + indent + line2 + "\n" //+ indent + line3 + "\n"
|
||||
|
|
@ -143,901 +151,4 @@ var Commands = func() map[string]Command {
|
|||
return commands
|
||||
}()
|
||||
|
||||
var commandsJSON = `{
|
||||
"SET":{
|
||||
"summary": "Sets the value of an id",
|
||||
"complexity": "O(1)",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"name": "string"
|
||||
},
|
||||
{
|
||||
"command": "FIELD",
|
||||
"name": ["name", "value"],
|
||||
"type": ["string", "double"],
|
||||
"optional": true,
|
||||
"multiple": true
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"enumargs": [
|
||||
{
|
||||
"name": "OBJECT",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "geojson",
|
||||
"type": "geojson"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "POINT",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "lat",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "lon",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "z",
|
||||
"type": "double",
|
||||
"optional": true
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "BOUNDS",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "minlat",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "minlon",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "maxlat",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "maxlon",
|
||||
"type": "double"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "HASH",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "geohash",
|
||||
"type": "geohash"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "crud"
|
||||
},
|
||||
"FSET": {
|
||||
"summary": "Set the value for a single field of an id",
|
||||
"complexity": "O(1)",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "field",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "double"
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "crud"
|
||||
},
|
||||
"GET": {
|
||||
"summary": "Get the object of an id",
|
||||
"complexity": "O(1)",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"optional": true,
|
||||
"enumargs": [
|
||||
{
|
||||
"name": "OBJECT"
|
||||
},
|
||||
{
|
||||
"name": "POINT"
|
||||
},
|
||||
{
|
||||
"name": "BOUNDS"
|
||||
},
|
||||
{
|
||||
"name": "HASH",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "precision",
|
||||
"type": "integer"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "crud"
|
||||
},
|
||||
"DEL": {
|
||||
"summary": "Delete an id from a key",
|
||||
"complexity": "O(1)",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "crud"
|
||||
},
|
||||
"DROP": {
|
||||
"summary": "Remove a key from the database",
|
||||
"complexity": "O(1)",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "crud"
|
||||
},
|
||||
"KEYS": {
|
||||
"summary": "Finds all keys matching the given pattern",
|
||||
"complexity": "O(N) where N is the number of keys in the database",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "pattern",
|
||||
"type": "pattern"
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "crud"
|
||||
},
|
||||
"STATS": {
|
||||
"summary": "Show stats for one or more keys",
|
||||
"complexity": "O(N) where N is the number of keys being requested",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string",
|
||||
"variadic": true
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "crud"
|
||||
},
|
||||
|
||||
"SCAN": {
|
||||
"summary": "Incrementally iterate though a key",
|
||||
"complexity": "O(N) where N is the number of ids in the key",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"command": "CURSOR",
|
||||
"name": "start",
|
||||
"type": "integer",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "LIMIT",
|
||||
"name": "count",
|
||||
"type": "integer",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "MATCH",
|
||||
"name": "pattern",
|
||||
"type": "pattern",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "WHERE",
|
||||
"name": ["field","min","max"],
|
||||
"type": ["string","double","double"],
|
||||
"optional": true,
|
||||
"multiple": true
|
||||
},
|
||||
{
|
||||
"command": "NOFIELDS",
|
||||
"name": [],
|
||||
"type": [],
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"optional": true,
|
||||
"enumargs": [
|
||||
{
|
||||
"name": "COUNT"
|
||||
},
|
||||
{
|
||||
"name": "IDS"
|
||||
},
|
||||
{
|
||||
"name": "OBJECTS"
|
||||
},
|
||||
{
|
||||
"name": "POINTS"
|
||||
},
|
||||
{
|
||||
"name": "BOUNDS"
|
||||
},
|
||||
{
|
||||
"name": "HASHES",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "precision",
|
||||
"type": "integer"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "search"
|
||||
},
|
||||
"NEARBY": {
|
||||
"summary": "Searches for ids that are nearby a point",
|
||||
"complexity": "O(log(N)) where N is the number of ids in the area",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"command": "CURSOR",
|
||||
"name": "start",
|
||||
"type": "integer",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "LIMIT",
|
||||
"name": "count",
|
||||
"type": "integer",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "SPARSE",
|
||||
"name": "spread",
|
||||
"type": "integer",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "MATCH",
|
||||
"name": "pattern",
|
||||
"type": "pattern",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "WHERE",
|
||||
"name": ["field","min","max"],
|
||||
"type": ["string","double","double"],
|
||||
"optional": true,
|
||||
"multiple": true
|
||||
},
|
||||
{
|
||||
"command": "NOFIELDS",
|
||||
"name": [],
|
||||
"type": [],
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "FENCE",
|
||||
"name": [],
|
||||
"type": [],
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"optional": true,
|
||||
"enumargs": [
|
||||
{
|
||||
"name": "COUNT"
|
||||
},
|
||||
{
|
||||
"name": "IDS"
|
||||
},
|
||||
{
|
||||
"name": "OBJECTS"
|
||||
},
|
||||
{
|
||||
"name": "POINTS"
|
||||
},
|
||||
{
|
||||
"name": "BOUNDS"
|
||||
},
|
||||
{
|
||||
"name": "HASHES",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "precision",
|
||||
"type": "integer"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"command": "POINT",
|
||||
"name": ["lat","lon","meters"],
|
||||
"type": ["double","double","double"]
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "search"
|
||||
},
|
||||
"WITHIN": {
|
||||
"summary": "Searches for ids that are nearby a point",
|
||||
"complexity": "O(log(N)) where N is the number of ids in the area",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"command": "CURSOR",
|
||||
"name": "start",
|
||||
"type": "integer",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "LIMIT",
|
||||
"name": "count",
|
||||
"type": "integer",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "SPARSE",
|
||||
"name": "spread",
|
||||
"type": "integer",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "MATCH",
|
||||
"name": "pattern",
|
||||
"type": "pattern",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "WHERE",
|
||||
"name": ["field","min","max"],
|
||||
"type": ["string","double","double"],
|
||||
"optional": true,
|
||||
"multiple": true
|
||||
},
|
||||
{
|
||||
"command": "NOFIELDS",
|
||||
"name": [],
|
||||
"type": [],
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "FENCE",
|
||||
"name": [],
|
||||
"type": [],
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"optional": true,
|
||||
"enumargs": [
|
||||
{
|
||||
"name": "COUNT"
|
||||
},
|
||||
{
|
||||
"name": "IDS"
|
||||
},
|
||||
{
|
||||
"name": "OBJECTS"
|
||||
},
|
||||
{
|
||||
"name": "POINTS"
|
||||
},
|
||||
{
|
||||
"name": "BOUNDS"
|
||||
},
|
||||
{
|
||||
"name": "HASHES",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "precision",
|
||||
"type": "integer"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "area",
|
||||
"enumargs": [
|
||||
{
|
||||
"name": "GET",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "BOUNDS",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "minlat",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "minlon",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "maxlat",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "maxlon",
|
||||
"type": "double"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "OBJECT",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "geojson",
|
||||
"type": "geojson"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "TILE",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "x",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "y",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "z",
|
||||
"type": "double"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "QUADKEY",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "quadkey",
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "HASH",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "precision",
|
||||
"type": "integer"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "search"
|
||||
},
|
||||
"INTERSECTS": {
|
||||
"summary": "Searches for ids that are nearby a point",
|
||||
"complexity": "O(log(N)) where N is the number of ids in the area",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"command": "CURSOR",
|
||||
"name": "start",
|
||||
"type": "integer",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "LIMIT",
|
||||
"name": "count",
|
||||
"type": "integer",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "SPARSE",
|
||||
"name": "spread",
|
||||
"type": "integer",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "MATCH",
|
||||
"name": "pattern",
|
||||
"type": "pattern",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "WHERE",
|
||||
"name": ["field","min","max"],
|
||||
"type": ["string","double","double"],
|
||||
"optional": true,
|
||||
"multiple": true
|
||||
},
|
||||
{
|
||||
"command": "NOFIELDS",
|
||||
"name": [],
|
||||
"type": [],
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "FENCE",
|
||||
"name": [],
|
||||
"type": [],
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"optional": true,
|
||||
"enumargs": [
|
||||
{
|
||||
"name": "COUNT"
|
||||
},
|
||||
{
|
||||
"name": "IDS"
|
||||
},
|
||||
{
|
||||
"name": "OBJECTS"
|
||||
},
|
||||
{
|
||||
"name": "POINTS"
|
||||
},
|
||||
{
|
||||
"name": "BOUNDS"
|
||||
},
|
||||
{
|
||||
"name": "HASHES",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "precision",
|
||||
"type": "integer"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "area",
|
||||
"enumargs": [
|
||||
{
|
||||
"name": "GET",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "BOUNDS",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "minlat",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "minlon",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "maxlat",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "maxlon",
|
||||
"type": "double"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "OBJECT",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "geojson",
|
||||
"type": "geojson"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "TILE",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "x",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "y",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "z",
|
||||
"type": "double"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "QUADKEY",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "quadkey",
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "HASH",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "precision",
|
||||
"type": "integer"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "search"
|
||||
},
|
||||
"CONFIG GET": {
|
||||
"summary": "Authenticate to the server",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "which",
|
||||
"enumargs": [
|
||||
{
|
||||
"name": "GET",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "parameter",
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "SET",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "parameter",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "string",
|
||||
"optional": true
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "REWRITE",
|
||||
"arguments":[]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"group": "connection"
|
||||
},
|
||||
"SERVER": {
|
||||
"summary":"Show server stats and details",
|
||||
"complexity": "O(1)",
|
||||
"arguments": [],
|
||||
"since": "1.0.0",
|
||||
"group": "server"
|
||||
},
|
||||
"GC": {
|
||||
"summary":"Forces a garbage collection",
|
||||
"complexity": "O(1)",
|
||||
"arguments": [],
|
||||
"since": "1.0.0",
|
||||
"group": "server"
|
||||
},
|
||||
"READONLY": {
|
||||
"summary": "Turns on or off readonly mode",
|
||||
"complexity": "O(1)",
|
||||
"arguments": [
|
||||
{
|
||||
"enum": ["yes","no"]
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "server"
|
||||
},
|
||||
"FLUSHDB": {
|
||||
"summary":"Removes all keys",
|
||||
"complexity": "O(1)",
|
||||
"arguments": [],
|
||||
"since": "1.0.0",
|
||||
"group": "server"
|
||||
},
|
||||
"FOLLOW": {
|
||||
"summary": "Follows a leader host",
|
||||
"complexity": "O(1)",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "host",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "port",
|
||||
"type": "integer"
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "replication"
|
||||
},
|
||||
"AOF": {
|
||||
"summary": "Downloads the AOF start from pos and keeps the connection alive",
|
||||
"complexity": "O(1)",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "pos",
|
||||
"type": "integer"
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "replication"
|
||||
},
|
||||
"AOFMD5": {
|
||||
"summary": "Performs a checksum on a portion of the aof",
|
||||
"complexity": "O(1)",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "pos",
|
||||
"type": "integer"
|
||||
},
|
||||
{
|
||||
"name": "sizs",
|
||||
"type": "integer"
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "replication"
|
||||
},
|
||||
"AOFSHRINK": {
|
||||
"summary": "Shrinks the aof in the background",
|
||||
"group": "replication"
|
||||
},
|
||||
"PING": {
|
||||
"summary": "Ping the server",
|
||||
"group": "connection"
|
||||
},
|
||||
"QUIT": {
|
||||
"summary": "Close the connection",
|
||||
"group": "connection"
|
||||
},
|
||||
"AUTH": {
|
||||
"summary": "Authenticate to the server",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "password",
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"group": "connection"
|
||||
}
|
||||
}`
|
||||
|
||||
// --- Crud ---
|
||||
// SET key id [FIELD name value ...] @input -- Sets the object of an id. -- O(1) -- F(key string, id string, name string, value double)
|
||||
// FSET key id name value -- Set a single field of an id. -- O(1) -- F(key string, id string, value double)
|
||||
// GET key id [OBJECT | POINT | BOUNDS | HASH precision] -- Get the object of an id. -- O(1) -- F(key string, id string)
|
||||
// DEL key id -- Delete an id. -- O(1) -- F(key string, id string)
|
||||
// DROP key -- Drops a key. -- O(1) -- F(key string)
|
||||
// KEYS pattern -- Finds all keys matching the given pattern. -- O(N) where N is the number of keys in the database -- F(pattern pattern)
|
||||
// STATS key [key ...] -- Show stats for one or more keys. -- O(N) where N is the number of keys being requested -- F(key string)
|
||||
|
||||
// --- Search ---
|
||||
// SCAN key @options @output -- Incrementally iterate though a key. Some options are not allowed such as FENCE and SPARCE. -- O(N) where N is the number of ids in the key -- F(key string)
|
||||
// NEARBY key @options @output POINT lat lon meters -- Searches for ids that are nearby a point. -- O(log(N)) where N is the number of ids in the area -- F(key string, lat double, lon double, meters double)
|
||||
// WITHIN key @options @output @area -- Searches for ids that are fullly contained inside area. -- O(log(N)) where N is the number of ids in the area -- F(key string)
|
||||
// INTERSECTS key @options @output @area -- Searches for ids that intersect an area. -- O(log(N)) where N is the number of ids in the area -- F(key string)
|
||||
|
||||
// --- Server ---
|
||||
// PING -- Ping the server. -- O(1) -- F()
|
||||
// SERVER -- Show server stats and details. -- O(1) -- F()
|
||||
// GC -- Forces a garbage collection. -- O(1) -- F()
|
||||
// HELP -- Prints this menu. -- O(1) -- F()
|
||||
// READONLY value -- Turn on or off readonly mode. -- O(1) -- F(value boolean)
|
||||
// FLUSHDB -- Removes all keys. -- O(1) -- F()
|
||||
// CONFIG SET property value -- Set a config property. Is not yet permanent.
|
||||
// CONFIG REWRITE -- Make config changes permanent.
|
||||
|
||||
// --- Replication ---
|
||||
// FOLLOW host port -- Follows a leader host. -- O(1) F(host string, port integer)
|
||||
// AOF pos -- Downloads an aof starting from pos. The connection does not close and continues to load data. -- O(1) F(pos integer)
|
||||
// AOFMD5 pos size -- Does a checksum on a portion of the aof. -- O(1) F(pos integer, size integer)
|
||||
// AOFSHRINK -- Shrinks the aof in the background. -- O(1) F()
|
||||
|
||||
// --- Dev ---
|
||||
// MASSINSERT keys count -- Randomly inserts objects in to specified number of key. -- O(N) where N is the number keys being created -- F(keys integer, count integer) -- !dev only!
|
||||
|
||||
// --- Parameters ---
|
||||
// @input (OBJECT... | POINT... | BOUNDS... | HASH...)
|
||||
// @options [CURSOR...] [LIMIT...] [SPARSE...] [MATCH...] [WHERE...] [NOFIELDS] [FENCE]
|
||||
// @output [COUNT | IDS | OBJECTS | POINTS | BOUNDS | HASHES...]
|
||||
// @area [GET... | BOUNDS... | OBJECT... | TILE... | QUADKEY... | HASH precision]
|
||||
// FENCE -- Opens a live fence. -- F()
|
||||
// FIELD... FIELD name value -- A name and value of a field. -- F(name string, value double)
|
||||
// CURSOR... CURSOR start -- Value indicating the starting position of the next page of data. -- F(start integer)
|
||||
// NOFIELDS NOFIELDS -- Do not return fields with the results. -- F()
|
||||
// LIMIT... LIMIT count -- Limit the number of items returned. default is 100. -- F(count integer)
|
||||
// WHERE... WHERE field min max -- Filters results where a field is between min and max. http://redis.io/commands/ZRANGEBYSCORE. -- F(field string, min integer, max integer)
|
||||
// MATCH... MATCH pattern -- Filters results where the id matched the pattern. -- F(pattern pattern)
|
||||
// BOUNDS... BOUNDS minlat minlon maxlat maxlon -- Bounding box. -- F(minlat double, minlon double, maxlat double, maxlon double)
|
||||
// OBJECT... OBJECT object -- Valid GeoJSON object. -- F(object geojson)
|
||||
// POINT... POINT lat lon [z] -- Standard coordinate. -- F(lat double, lon double, z double)
|
||||
// HASHES... HASHES precision -- Geohash. The precision must between 1 and 22. -- F(precision double)
|
||||
// HASH... HASH hash -- Geohash. -- F(hash geohash)
|
||||
// QUADKEY... QUADKEY key -- Quadkey. -- F(key quadkey)
|
||||
// TILE... TILE x y z -- Google XYZ tile. -- F(x double, y double, z double)
|
||||
// GET... GET key id -- An internal object. -- F(key string, id string)
|
||||
|
||||
// --- Security ---
|
||||
// AUTH password -- Authenticate to server.
|
||||
var commandsJSON = `{{.CommandsJSON}}`
|
||||
|
|
|
|||
|
|
@ -701,23 +701,18 @@
|
|||
"since": "1.0.0",
|
||||
"group": "search"
|
||||
},
|
||||
"CONFIG": {
|
||||
"summary": "Authenticate to the server",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "which",
|
||||
"enumargs": [
|
||||
{
|
||||
"name": "GET",
|
||||
"CONFIG GET": {
|
||||
"summary": "Get the value of a configuration parameter",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "parameter",
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
],
|
||||
"group": "server"
|
||||
},
|
||||
{
|
||||
"name": "SET",
|
||||
"CONFIG SET": {
|
||||
"summary": "Set a configuration parameter to the given value",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "parameter",
|
||||
|
|
@ -728,16 +723,13 @@
|
|||
"type": "string",
|
||||
"optional": true
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "REWRITE",
|
||||
"arguments":[]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"group": "connection"
|
||||
"group": "server"
|
||||
},
|
||||
"CONFIG REWRITE": {
|
||||
"summary": "Rewrite the configuration file with the in memory configuration",
|
||||
"arguments":[],
|
||||
"group": "server"
|
||||
},
|
||||
"SERVER": {
|
||||
"summary":"Show server stats and details",
|
||||
|
|
|
|||
|
|
@ -0,0 +1,985 @@
|
|||
// This file was autogenerated. DO NOT EDIT.
|
||||
|
||||
package core
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"strings"
|
||||
)
|
||||
|
||||
const (
|
||||
clear = "\x1b[0m"
|
||||
bright = "\x1b[1m"
|
||||
gray = "\x1b[90m"
|
||||
yellow = "\x1b[33m"
|
||||
)
|
||||
|
||||
type Command struct {
|
||||
Name string `json:"-"`
|
||||
Summary string `json:"summary"`
|
||||
Complexity string `json:"complexity"`
|
||||
Arguments []Argument `json:"arguments"`
|
||||
Since string `json:"since"`
|
||||
Group string `json:"group"`
|
||||
DevOnly bool `json:"dev"`
|
||||
}
|
||||
|
||||
func (c Command) String() string {
|
||||
var s = c.Name
|
||||
for _, arg := range c.Arguments {
|
||||
s += " " + arg.String()
|
||||
}
|
||||
return s
|
||||
}
|
||||
|
||||
func (c Command) TermOutput(indent string) string {
|
||||
line := c.String()
|
||||
var line1 string
|
||||
if strings.HasPrefix(line, c.Name) {
|
||||
line1 = bright + c.Name + clear + gray + line[len(c.Name):] + clear
|
||||
} else {
|
||||
line1 = bright + strings.Replace(c.String(), " ", " "+clear+gray, 1) + clear
|
||||
}
|
||||
line2 := yellow + "summary: " + clear + c.Summary
|
||||
//line3 := yellow + "since: " + clear + c.Since
|
||||
return indent + line1 + "\n" + indent + line2 + "\n" //+ indent + line3 + "\n"
|
||||
}
|
||||
|
||||
type EnumArg struct {
|
||||
Name string `json:"name"`
|
||||
Arguments []Argument `json:"arguments"`
|
||||
}
|
||||
|
||||
func (a EnumArg) String() string {
|
||||
var s = a.Name
|
||||
for _, arg := range a.Arguments {
|
||||
s += " " + arg.String()
|
||||
}
|
||||
return s
|
||||
}
|
||||
|
||||
type Argument struct {
|
||||
Command string `json:"command"`
|
||||
NameAny interface{} `json:"name"`
|
||||
TypeAny interface{} `json:"type"`
|
||||
Optional bool `json:"optional"`
|
||||
Multiple bool `json:"multiple"`
|
||||
Variadic bool `json:"variadic"`
|
||||
Enum []string `json:"enum"`
|
||||
EnumArgs []EnumArg `json:"enumargs"`
|
||||
}
|
||||
|
||||
func (a Argument) String() string {
|
||||
var s string
|
||||
if a.Command != "" {
|
||||
s += " " + a.Command
|
||||
}
|
||||
if len(a.EnumArgs) > 0 {
|
||||
eargs := ""
|
||||
for _, arg := range a.EnumArgs {
|
||||
v := arg.String()
|
||||
if strings.Contains(v, " ") {
|
||||
v = "(" + v + ")"
|
||||
}
|
||||
eargs += v + "|"
|
||||
}
|
||||
if len(eargs) > 0 {
|
||||
eargs = eargs[:len(eargs)-1]
|
||||
}
|
||||
s += " " + eargs
|
||||
} else if len(a.Enum) > 0 {
|
||||
s += " " + strings.Join(a.Enum, "|")
|
||||
} else {
|
||||
names, _ := a.NameTypes()
|
||||
subs := ""
|
||||
for _, name := range names {
|
||||
subs += " " + name
|
||||
}
|
||||
subs = strings.TrimSpace(subs)
|
||||
s += " " + subs
|
||||
if a.Variadic {
|
||||
s += " [" + subs + " ...]"
|
||||
}
|
||||
if a.Multiple {
|
||||
s += " ..."
|
||||
}
|
||||
}
|
||||
s = strings.TrimSpace(s)
|
||||
if a.Optional {
|
||||
s = "[" + s + "]"
|
||||
}
|
||||
return s
|
||||
}
|
||||
|
||||
func parseAnyStringArray(any interface{}) []string {
|
||||
if str, ok := any.(string); ok {
|
||||
return []string{str}
|
||||
} else if any, ok := any.([]interface{}); ok {
|
||||
arr := []string{}
|
||||
for _, any := range any {
|
||||
if str, ok := any.(string); ok {
|
||||
arr = append(arr, str)
|
||||
}
|
||||
}
|
||||
return arr
|
||||
}
|
||||
return []string{}
|
||||
}
|
||||
|
||||
func (a Argument) NameTypes() (names, types []string) {
|
||||
names = parseAnyStringArray(a.NameAny)
|
||||
types = parseAnyStringArray(a.TypeAny)
|
||||
if len(types) > len(names) {
|
||||
types = types[:len(names)]
|
||||
} else {
|
||||
for len(types) < len(names) {
|
||||
types = append(types, "")
|
||||
}
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
var Commands = func() map[string]Command {
|
||||
var commands map[string]Command
|
||||
if err := json.Unmarshal([]byte(commandsJSON), &commands); err != nil {
|
||||
panic(err.Error())
|
||||
}
|
||||
for name, command := range commands {
|
||||
command.Name = strings.ToUpper(name)
|
||||
commands[name] = command
|
||||
}
|
||||
return commands
|
||||
}()
|
||||
|
||||
var commandsJSON = `{
|
||||
"SET":{
|
||||
"summary": "Sets the value of an id",
|
||||
"complexity": "O(1)",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"name": "string"
|
||||
},
|
||||
{
|
||||
"command": "FIELD",
|
||||
"name": ["name", "value"],
|
||||
"type": ["string", "double"],
|
||||
"optional": true,
|
||||
"multiple": true
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"enumargs": [
|
||||
{
|
||||
"name": "OBJECT",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "geojson",
|
||||
"type": "geojson"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "POINT",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "lat",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "lon",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "z",
|
||||
"type": "double",
|
||||
"optional": true
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "BOUNDS",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "minlat",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "minlon",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "maxlat",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "maxlon",
|
||||
"type": "double"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "HASH",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "geohash",
|
||||
"type": "geohash"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "crud"
|
||||
},
|
||||
"FSET": {
|
||||
"summary": "Set the value for a single field of an id",
|
||||
"complexity": "O(1)",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "field",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "double"
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "crud"
|
||||
},
|
||||
"GET": {
|
||||
"summary": "Get the object of an id",
|
||||
"complexity": "O(1)",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"optional": true,
|
||||
"enumargs": [
|
||||
{
|
||||
"name": "OBJECT"
|
||||
},
|
||||
{
|
||||
"name": "POINT"
|
||||
},
|
||||
{
|
||||
"name": "BOUNDS"
|
||||
},
|
||||
{
|
||||
"name": "HASH",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "precision",
|
||||
"type": "integer"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "crud"
|
||||
},
|
||||
"DEL": {
|
||||
"summary": "Delete an id from a key",
|
||||
"complexity": "O(1)",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "crud"
|
||||
},
|
||||
"DROP": {
|
||||
"summary": "Remove a key from the database",
|
||||
"complexity": "O(1)",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "crud"
|
||||
},
|
||||
"KEYS": {
|
||||
"summary": "Finds all keys matching the given pattern",
|
||||
"complexity": "O(N) where N is the number of keys in the database",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "pattern",
|
||||
"type": "pattern"
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "crud"
|
||||
},
|
||||
"STATS": {
|
||||
"summary": "Show stats for one or more keys",
|
||||
"complexity": "O(N) where N is the number of keys being requested",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string",
|
||||
"variadic": true
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "crud"
|
||||
},
|
||||
|
||||
"SCAN": {
|
||||
"summary": "Incrementally iterate though a key",
|
||||
"complexity": "O(N) where N is the number of ids in the key",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"command": "CURSOR",
|
||||
"name": "start",
|
||||
"type": "integer",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "LIMIT",
|
||||
"name": "count",
|
||||
"type": "integer",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "MATCH",
|
||||
"name": "pattern",
|
||||
"type": "pattern",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "WHERE",
|
||||
"name": ["field","min","max"],
|
||||
"type": ["string","double","double"],
|
||||
"optional": true,
|
||||
"multiple": true
|
||||
},
|
||||
{
|
||||
"command": "NOFIELDS",
|
||||
"name": [],
|
||||
"type": [],
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"optional": true,
|
||||
"enumargs": [
|
||||
{
|
||||
"name": "COUNT"
|
||||
},
|
||||
{
|
||||
"name": "IDS"
|
||||
},
|
||||
{
|
||||
"name": "OBJECTS"
|
||||
},
|
||||
{
|
||||
"name": "POINTS"
|
||||
},
|
||||
{
|
||||
"name": "BOUNDS"
|
||||
},
|
||||
{
|
||||
"name": "HASHES",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "precision",
|
||||
"type": "integer"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "search"
|
||||
},
|
||||
"NEARBY": {
|
||||
"summary": "Searches for ids that are nearby a point",
|
||||
"complexity": "O(log(N)) where N is the number of ids in the area",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"command": "CURSOR",
|
||||
"name": "start",
|
||||
"type": "integer",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "LIMIT",
|
||||
"name": "count",
|
||||
"type": "integer",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "SPARSE",
|
||||
"name": "spread",
|
||||
"type": "integer",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "MATCH",
|
||||
"name": "pattern",
|
||||
"type": "pattern",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "WHERE",
|
||||
"name": ["field","min","max"],
|
||||
"type": ["string","double","double"],
|
||||
"optional": true,
|
||||
"multiple": true
|
||||
},
|
||||
{
|
||||
"command": "NOFIELDS",
|
||||
"name": [],
|
||||
"type": [],
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "FENCE",
|
||||
"name": [],
|
||||
"type": [],
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"optional": true,
|
||||
"enumargs": [
|
||||
{
|
||||
"name": "COUNT"
|
||||
},
|
||||
{
|
||||
"name": "IDS"
|
||||
},
|
||||
{
|
||||
"name": "OBJECTS"
|
||||
},
|
||||
{
|
||||
"name": "POINTS"
|
||||
},
|
||||
{
|
||||
"name": "BOUNDS"
|
||||
},
|
||||
{
|
||||
"name": "HASHES",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "precision",
|
||||
"type": "integer"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"command": "POINT",
|
||||
"name": ["lat","lon","meters"],
|
||||
"type": ["double","double","double"]
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "search"
|
||||
},
|
||||
"WITHIN": {
|
||||
"summary": "Searches for ids that are nearby a point",
|
||||
"complexity": "O(log(N)) where N is the number of ids in the area",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"command": "CURSOR",
|
||||
"name": "start",
|
||||
"type": "integer",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "LIMIT",
|
||||
"name": "count",
|
||||
"type": "integer",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "SPARSE",
|
||||
"name": "spread",
|
||||
"type": "integer",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "MATCH",
|
||||
"name": "pattern",
|
||||
"type": "pattern",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "WHERE",
|
||||
"name": ["field","min","max"],
|
||||
"type": ["string","double","double"],
|
||||
"optional": true,
|
||||
"multiple": true
|
||||
},
|
||||
{
|
||||
"command": "NOFIELDS",
|
||||
"name": [],
|
||||
"type": [],
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "FENCE",
|
||||
"name": [],
|
||||
"type": [],
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"optional": true,
|
||||
"enumargs": [
|
||||
{
|
||||
"name": "COUNT"
|
||||
},
|
||||
{
|
||||
"name": "IDS"
|
||||
},
|
||||
{
|
||||
"name": "OBJECTS"
|
||||
},
|
||||
{
|
||||
"name": "POINTS"
|
||||
},
|
||||
{
|
||||
"name": "BOUNDS"
|
||||
},
|
||||
{
|
||||
"name": "HASHES",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "precision",
|
||||
"type": "integer"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "area",
|
||||
"enumargs": [
|
||||
{
|
||||
"name": "GET",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "BOUNDS",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "minlat",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "minlon",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "maxlat",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "maxlon",
|
||||
"type": "double"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "OBJECT",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "geojson",
|
||||
"type": "geojson"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "TILE",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "x",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "y",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "z",
|
||||
"type": "double"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "QUADKEY",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "quadkey",
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "HASH",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "precision",
|
||||
"type": "integer"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "search"
|
||||
},
|
||||
"INTERSECTS": {
|
||||
"summary": "Searches for ids that are nearby a point",
|
||||
"complexity": "O(log(N)) where N is the number of ids in the area",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"command": "CURSOR",
|
||||
"name": "start",
|
||||
"type": "integer",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "LIMIT",
|
||||
"name": "count",
|
||||
"type": "integer",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "SPARSE",
|
||||
"name": "spread",
|
||||
"type": "integer",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "MATCH",
|
||||
"name": "pattern",
|
||||
"type": "pattern",
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "WHERE",
|
||||
"name": ["field","min","max"],
|
||||
"type": ["string","double","double"],
|
||||
"optional": true,
|
||||
"multiple": true
|
||||
},
|
||||
{
|
||||
"command": "NOFIELDS",
|
||||
"name": [],
|
||||
"type": [],
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"command": "FENCE",
|
||||
"name": [],
|
||||
"type": [],
|
||||
"optional": true
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"optional": true,
|
||||
"enumargs": [
|
||||
{
|
||||
"name": "COUNT"
|
||||
},
|
||||
{
|
||||
"name": "IDS"
|
||||
},
|
||||
{
|
||||
"name": "OBJECTS"
|
||||
},
|
||||
{
|
||||
"name": "POINTS"
|
||||
},
|
||||
{
|
||||
"name": "BOUNDS"
|
||||
},
|
||||
{
|
||||
"name": "HASHES",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "precision",
|
||||
"type": "integer"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "area",
|
||||
"enumargs": [
|
||||
{
|
||||
"name": "GET",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "BOUNDS",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "minlat",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "minlon",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "maxlat",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "maxlon",
|
||||
"type": "double"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "OBJECT",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "geojson",
|
||||
"type": "geojson"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "TILE",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "x",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "y",
|
||||
"type": "double"
|
||||
},
|
||||
{
|
||||
"name": "z",
|
||||
"type": "double"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "QUADKEY",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "quadkey",
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "HASH",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "precision",
|
||||
"type": "integer"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "search"
|
||||
},
|
||||
"CONFIG GET": {
|
||||
"summary": "Get the value of a configuration parameter",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "parameter",
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"group": "server"
|
||||
},
|
||||
"CONFIG SET": {
|
||||
"summary": "Set a configuration parameter to the given value",
|
||||
"arguments":[
|
||||
{
|
||||
"name": "parameter",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "string",
|
||||
"optional": true
|
||||
}
|
||||
],
|
||||
"group": "server"
|
||||
},
|
||||
"CONFIG REWRITE": {
|
||||
"summary": "Rewrite the configuration file with the in memory configuration",
|
||||
"arguments":[],
|
||||
"group": "server"
|
||||
},
|
||||
"SERVER": {
|
||||
"summary":"Show server stats and details",
|
||||
"complexity": "O(1)",
|
||||
"arguments": [],
|
||||
"since": "1.0.0",
|
||||
"group": "server"
|
||||
},
|
||||
"GC": {
|
||||
"summary":"Forces a garbage collection",
|
||||
"complexity": "O(1)",
|
||||
"arguments": [],
|
||||
"since": "1.0.0",
|
||||
"group": "server"
|
||||
},
|
||||
"READONLY": {
|
||||
"summary": "Turns on or off readonly mode",
|
||||
"complexity": "O(1)",
|
||||
"arguments": [
|
||||
{
|
||||
"enum": ["yes","no"]
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "server"
|
||||
},
|
||||
"FLUSHDB": {
|
||||
"summary":"Removes all keys",
|
||||
"complexity": "O(1)",
|
||||
"arguments": [],
|
||||
"since": "1.0.0",
|
||||
"group": "server"
|
||||
},
|
||||
"FOLLOW": {
|
||||
"summary": "Follows a leader host",
|
||||
"complexity": "O(1)",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "host",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "port",
|
||||
"type": "integer"
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "replication"
|
||||
},
|
||||
"AOF": {
|
||||
"summary": "Downloads the AOF start from pos and keeps the connection alive",
|
||||
"complexity": "O(1)",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "pos",
|
||||
"type": "integer"
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "replication"
|
||||
},
|
||||
"AOFMD5": {
|
||||
"summary": "Performs a checksum on a portion of the aof",
|
||||
"complexity": "O(1)",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "pos",
|
||||
"type": "integer"
|
||||
},
|
||||
{
|
||||
"name": "sizs",
|
||||
"type": "integer"
|
||||
}
|
||||
],
|
||||
"since": "1.0.0",
|
||||
"group": "replication"
|
||||
},
|
||||
"AOFSHRINK": {
|
||||
"summary": "Shrinks the aof in the background",
|
||||
"group": "replication"
|
||||
},
|
||||
"PING": {
|
||||
"summary": "Ping the server",
|
||||
"group": "connection"
|
||||
},
|
||||
"QUIT": {
|
||||
"summary": "Close the connection",
|
||||
"group": "connection"
|
||||
},
|
||||
"AUTH": {
|
||||
"summary": "Authenticate to the server",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "password",
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"group": "connection"
|
||||
}
|
||||
}`
|
||||
|
|
@ -1,206 +0,0 @@
|
|||
// +build ignore
|
||||
|
||||
package core
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"strings"
|
||||
)
|
||||
|
||||
const (
|
||||
clear = "\x1b[0m"
|
||||
bright = "\x1b[1m"
|
||||
gray = "\x1b[90m"
|
||||
yellow = "\x1b[33m"
|
||||
)
|
||||
|
||||
type Command struct {
|
||||
Name string `json:"-"`
|
||||
Summary string `json:"summary"`
|
||||
Complexity string `json:"complexity"`
|
||||
Arguments []Argument `json:"arguments"`
|
||||
Since string `json:"since"`
|
||||
Group string `json:"group"`
|
||||
DevOnly bool `json:"dev"`
|
||||
}
|
||||
|
||||
func (c Command) String() string {
|
||||
var s = c.Name
|
||||
for _, arg := range c.Arguments {
|
||||
s += " " + arg.String()
|
||||
}
|
||||
return s
|
||||
}
|
||||
|
||||
func (c Command) TermOutput(indent string) string {
|
||||
line1 := bright + strings.Replace(c.String(), " ", " "+clear+gray, 1) + clear
|
||||
line2 := yellow + "summary: " + clear + c.Summary
|
||||
//line3 := yellow + "since: " + clear + c.Since
|
||||
return indent + line1 + "\n" + indent + line2 + "\n" //+ indent + line3 + "\n"
|
||||
}
|
||||
|
||||
type EnumArg struct {
|
||||
Name string `json:"name"`
|
||||
Arguments []Argument `json:"arguments"`
|
||||
}
|
||||
|
||||
func (a EnumArg) String() string {
|
||||
var s = a.Name
|
||||
for _, arg := range a.Arguments {
|
||||
s += " " + arg.String()
|
||||
}
|
||||
return s
|
||||
}
|
||||
|
||||
type Argument struct {
|
||||
Command string `json:"command"`
|
||||
NameAny interface{} `json:"name"`
|
||||
TypeAny interface{} `json:"type"`
|
||||
Optional bool `json:"optional"`
|
||||
Multiple bool `json:"multiple"`
|
||||
Variadic bool `json:"variadic"`
|
||||
Enum []string `json:"enum"`
|
||||
EnumArgs []EnumArg `json:"enumargs"`
|
||||
}
|
||||
|
||||
func (a Argument) String() string {
|
||||
var s string
|
||||
if a.Command != "" {
|
||||
s += " " + a.Command
|
||||
}
|
||||
if len(a.EnumArgs) > 0 {
|
||||
eargs := ""
|
||||
for _, arg := range a.EnumArgs {
|
||||
v := arg.String()
|
||||
if strings.Contains(v, " ") {
|
||||
v = "(" + v + ")"
|
||||
}
|
||||
eargs += v + "|"
|
||||
}
|
||||
if len(eargs) > 0 {
|
||||
eargs = eargs[:len(eargs)-1]
|
||||
}
|
||||
s += " " + eargs
|
||||
} else if len(a.Enum) > 0 {
|
||||
s += " " + strings.Join(a.Enum, "|")
|
||||
} else {
|
||||
names, _ := a.NameTypes()
|
||||
subs := ""
|
||||
for _, name := range names {
|
||||
subs += " " + name
|
||||
}
|
||||
subs = strings.TrimSpace(subs)
|
||||
s += " " + subs
|
||||
if a.Variadic {
|
||||
s += " [" + subs + " ...]"
|
||||
}
|
||||
if a.Multiple {
|
||||
s += " ..."
|
||||
}
|
||||
}
|
||||
s = strings.TrimSpace(s)
|
||||
if a.Optional {
|
||||
s = "[" + s + "]"
|
||||
}
|
||||
return s
|
||||
}
|
||||
|
||||
func parseAnyStringArray(any interface{}) []string {
|
||||
if str, ok := any.(string); ok {
|
||||
return []string{str}
|
||||
} else if any, ok := any.([]interface{}); ok {
|
||||
arr := []string{}
|
||||
for _, any := range any {
|
||||
if str, ok := any.(string); ok {
|
||||
arr = append(arr, str)
|
||||
}
|
||||
}
|
||||
return arr
|
||||
}
|
||||
return []string{}
|
||||
}
|
||||
|
||||
func (a Argument) NameTypes() (names, types []string) {
|
||||
names = parseAnyStringArray(a.NameAny)
|
||||
types = parseAnyStringArray(a.TypeAny)
|
||||
if len(types) > len(names) {
|
||||
types = types[:len(names)]
|
||||
} else {
|
||||
for len(types) < len(names) {
|
||||
types = append(types, "")
|
||||
}
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
var Commands = func() map[string]Command {
|
||||
var commands map[string]Command
|
||||
if err := json.Unmarshal([]byte(commandsJSON), &commands); err != nil {
|
||||
panic(err.Error())
|
||||
}
|
||||
for name, command := range commands {
|
||||
command.Name = strings.ToUpper(name)
|
||||
commands[name] = command
|
||||
}
|
||||
return commands
|
||||
}()
|
||||
|
||||
var commandsJSON = `{{.CommandsJSON}}`
|
||||
|
||||
// --- Crud ---
|
||||
// SET key id [FIELD name value ...] @input -- Sets the object of an id. -- O(1) -- F(key string, id string, name string, value double)
|
||||
// FSET key id name value -- Set a single field of an id. -- O(1) -- F(key string, id string, value double)
|
||||
// GET key id [OBJECT | POINT | BOUNDS | HASH precision] -- Get the object of an id. -- O(1) -- F(key string, id string)
|
||||
// DEL key id -- Delete an id. -- O(1) -- F(key string, id string)
|
||||
// DROP key -- Drops a key. -- O(1) -- F(key string)
|
||||
// KEYS pattern -- Finds all keys matching the given pattern. -- O(N) where N is the number of keys in the database -- F(pattern pattern)
|
||||
// STATS key [key ...] -- Show stats for one or more keys. -- O(N) where N is the number of keys being requested -- F(key string)
|
||||
|
||||
// --- Search ---
|
||||
// SCAN key @options @output -- Incrementally iterate though a key. Some options are not allowed such as FENCE and SPARCE. -- O(N) where N is the number of ids in the key -- F(key string)
|
||||
// NEARBY key @options @output POINT lat lon meters -- Searches for ids that are nearby a point. -- O(log(N)) where N is the number of ids in the area -- F(key string, lat double, lon double, meters double)
|
||||
// WITHIN key @options @output @area -- Searches for ids that are fullly contained inside area. -- O(log(N)) where N is the number of ids in the area -- F(key string)
|
||||
// INTERSECTS key @options @output @area -- Searches for ids that intersect an area. -- O(log(N)) where N is the number of ids in the area -- F(key string)
|
||||
|
||||
// --- Server ---
|
||||
// PING -- Ping the server. -- O(1) -- F()
|
||||
// SERVER -- Show server stats and details. -- O(1) -- F()
|
||||
// GC -- Forces a garbage collection. -- O(1) -- F()
|
||||
// HELP -- Prints this menu. -- O(1) -- F()
|
||||
// READONLY value -- Turn on or off readonly mode. -- O(1) -- F(value boolean)
|
||||
// FLUSHDB -- Removes all keys. -- O(1) -- F()
|
||||
// CONFIG SET property value -- Set a config property. Is not yet permanent.
|
||||
// CONFIG REWRITE -- Make config changes permanent.
|
||||
|
||||
// --- Replication ---
|
||||
// FOLLOW host port -- Follows a leader host. -- O(1) F(host string, port integer)
|
||||
// AOF pos -- Downloads an aof starting from pos. The connection does not close and continues to load data. -- O(1) F(pos integer)
|
||||
// AOFMD5 pos size -- Does a checksum on a portion of the aof. -- O(1) F(pos integer, size integer)
|
||||
// AOFSHRINK -- Shrinks the aof in the background. -- O(1) F()
|
||||
|
||||
// --- Dev ---
|
||||
// MASSINSERT keys count -- Randomly inserts objects in to specified number of key. -- O(N) where N is the number keys being created -- F(keys integer, count integer) -- !dev only!
|
||||
|
||||
// --- Parameters ---
|
||||
// @input (OBJECT... | POINT... | BOUNDS... | HASH...)
|
||||
// @options [CURSOR...] [LIMIT...] [SPARSE...] [MATCH...] [WHERE...] [NOFIELDS] [FENCE]
|
||||
// @output [COUNT | IDS | OBJECTS | POINTS | BOUNDS | HASHES...]
|
||||
// @area [GET... | BOUNDS... | OBJECT... | TILE... | QUADKEY... | HASH precision]
|
||||
// FENCE -- Opens a live fence. -- F()
|
||||
// FIELD... FIELD name value -- A name and value of a field. -- F(name string, value double)
|
||||
// CURSOR... CURSOR start -- Value indicating the starting position of the next page of data. -- F(start integer)
|
||||
// NOFIELDS NOFIELDS -- Do not return fields with the results. -- F()
|
||||
// LIMIT... LIMIT count -- Limit the number of items returned. default is 100. -- F(count integer)
|
||||
// WHERE... WHERE field min max -- Filters results where a field is between min and max. http://redis.io/commands/ZRANGEBYSCORE. -- F(field string, min integer, max integer)
|
||||
// MATCH... MATCH pattern -- Filters results where the id matched the pattern. -- F(pattern pattern)
|
||||
// BOUNDS... BOUNDS minlat minlon maxlat maxlon -- Bounding box. -- F(minlat double, minlon double, maxlat double, maxlon double)
|
||||
// OBJECT... OBJECT object -- Valid GeoJSON object. -- F(object geojson)
|
||||
// POINT... POINT lat lon [z] -- Standard coordinate. -- F(lat double, lon double, z double)
|
||||
// HASHES... HASHES precision -- Geohash. The precision must between 1 and 22. -- F(precision double)
|
||||
// HASH... HASH hash -- Geohash. -- F(hash geohash)
|
||||
// QUADKEY... QUADKEY key -- Quadkey. -- F(key quadkey)
|
||||
// TILE... TILE x y z -- Google XYZ tile. -- F(x double, y double, z double)
|
||||
// GET... GET key id -- An internal object. -- F(key string, id string)
|
||||
|
||||
// --- Security ---
|
||||
// AUTH password -- Authenticate to server.
|
||||
|
|
@ -10,9 +10,8 @@ perl -pe '
|
|||
while (($i = index($_, "{{.CommandsJSON}}")) != -1) {
|
||||
substr($_, $i, length("{{.CommandsJSON}}")) = $ENV{"CommandsJSON"};
|
||||
}
|
||||
' commands_template.go > commands.go
|
||||
' commands.go > commands_gen.go
|
||||
|
||||
# remove the ignore
|
||||
sed -i -e 's/\/\/ +build ignore//g' commands.go
|
||||
rm -rf commands.go-e
|
||||
gofmt -w commands.go
|
||||
sed -i -e 's/\/\/ +build ignore/\/\/ This file was autogenerated. DO NOT EDIT./g' commands_gen.go
|
||||
rm -rf commands_gen.go-e
|
||||
|
|
|
|||
Loading…
Reference in New Issue