httpapi

package

v0.0.0-...-40a7436 Latest Latest Go to latest Published: Apr 9, 2015 License: BSD-2-Clause Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/c4e8ece0/tiedot

Links

Open Source Insights

Documentation ¶

Overview ¶

Collection management handlers.

Document management handlers.

Index management handlers.

Miscellaneous function handlers.

Query handlers.

HTTP service API handler registration.

Index ¶

Constants
Variables
func All(w http.ResponseWriter, r *http.Request)
func ApproxDocCount(w http.ResponseWriter, r *http.Request)
func Count(w http.ResponseWriter, r *http.Request)
func Create(w http.ResponseWriter, r *http.Request)
func Delete(w http.ResponseWriter, r *http.Request)
func Drop(w http.ResponseWriter, r *http.Request)
func Dump(w http.ResponseWriter, r *http.Request)
func Get(w http.ResponseWriter, r *http.Request)
func GetPage(w http.ResponseWriter, r *http.Request)
func Index(w http.ResponseWriter, r *http.Request)
func Indexes(w http.ResponseWriter, r *http.Request)
func Insert(w http.ResponseWriter, r *http.Request)
func MemStats(w http.ResponseWriter, r *http.Request)
func Query(w http.ResponseWriter, r *http.Request)
func Rename(w http.ResponseWriter, r *http.Request)
func Require(w http.ResponseWriter, r *http.Request, key string, val *string) bool
func Scrub(w http.ResponseWriter, r *http.Request)
func ServeEndpoints()
func ServeJWTEnabledEndpoints(jwtPubKey, jwtPrivateKey string)
func Shutdown(w http.ResponseWriter, r *http.Request)
func Start(dir string, port int, tlsCrt, tlsKey, jwtPubKey, jwtPrivateKey string)
func Sync(w http.ResponseWriter, r *http.Request)
func Unindex(w http.ResponseWriter, r *http.Request)
func Update(w http.ResponseWriter, r *http.Request)
func Version(w http.ResponseWriter, r *http.Request)
func Welcome(w http.ResponseWriter, r *http.Request)

Constants ¶

View Source

const (
	// JWT Record and claim
	JWT_COL_NAME         = "jwt"
	JWT_USER_ATTR        = "user"
	JWT_PASS_ATTR        = "pass"
	JWT_ENDPOINTS_ATTR   = "endpoints"
	JWT_COLLECTIONS_ATTR = "collections"
	JWT_USER_ADMIN       = "admin"
	// JWT claim
	JWT_EXPIRY = "exp"
)

Variables ¶

View Source

var (
	HttpDB *db.DB
)

Functions ¶

func All ¶

func All(w http.ResponseWriter, r *http.Request)

Return all collection names.

func ApproxDocCount ¶

func ApproxDocCount(w http.ResponseWriter, r *http.Request)

Return approximate number of documents in the collection.

func Count ¶

func Count(w http.ResponseWriter, r *http.Request)

Execute a query and return number of documents from the result.

func Create ¶

func Create(w http.ResponseWriter, r *http.Request)

Create a collection.

func Delete ¶

func Delete(w http.ResponseWriter, r *http.Request)

Delete a document.

func Drop ¶

func Drop(w http.ResponseWriter, r *http.Request)

Drop a collection.

func Dump ¶

func Dump(w http.ResponseWriter, r *http.Request)

Copy this database into destination directory.

func Get ¶

func Get(w http.ResponseWriter, r *http.Request)

Find and retrieve a document by ID.

func GetPage ¶

func GetPage(w http.ResponseWriter, r *http.Request)

Divide documents into roughly equally sized pages, and return documents in the specified page.

func Index ¶

func Index(w http.ResponseWriter, r *http.Request)

Put an index on a document path.

func Indexes ¶

func Indexes(w http.ResponseWriter, r *http.Request)

Return all indexed paths.

func Insert ¶

func Insert(w http.ResponseWriter, r *http.Request)

Insert a document into collection.

func MemStats ¶

func MemStats(w http.ResponseWriter, r *http.Request)

Return server memory statistics.

func Query ¶

func Query(w http.ResponseWriter, r *http.Request)

Execute a query and return documents from the result.

func Rename ¶

func Rename(w http.ResponseWriter, r *http.Request)

Rename a collection.

func Require ¶

func Require(w http.ResponseWriter, r *http.Request, key string, val *string) bool

Store form parameter value of specified key to *val and return true; if key does not exist, set HTTP status 400 and return false.

func Scrub ¶

func Scrub(w http.ResponseWriter, r *http.Request)

De-fragment collection free space and fix corrupted documents.

func ServeEndpoints ¶

func ServeEndpoints()

func ServeJWTEnabledEndpoints ¶

func ServeJWTEnabledEndpoints(jwtPubKey, jwtPrivateKey string)

func Shutdown ¶

func Shutdown(w http.ResponseWriter, r *http.Request)

Flush and close all data files and shutdown the entire program.

func Start ¶

func Start(dir string, port int, tlsCrt, tlsKey, jwtPubKey, jwtPrivateKey string)

func Sync ¶

func Sync(w http.ResponseWriter, r *http.Request)

Noop

func Unindex ¶

func Unindex(w http.ResponseWriter, r *http.Request)

Remove an indexed path.

func Update ¶

func Update(w http.ResponseWriter, r *http.Request)

Update a document.

func Version ¶

func Version(w http.ResponseWriter, r *http.Request)

Return server protocol version number.

func Welcome ¶

func Welcome(w http.ResponseWriter, r *http.Request)

Greet user with a welcome message.

Types ¶

This section is empty.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL