package
0.19.9-preview-3
Repository: https://github.com/arangodb-helper/arangodb.git
Documentation: pkg.go.dev

# Functions

DefaultHTTPClient creates a new HTTP client configured for accessing a starter.
IsBadRequest returns true if the given error is caused by a BadRequestError.
IsInternalServer returns true if the given error is caused by a InternalServerError.
IsNotFound returns true if the given error is caused by a NotFoundError.
IsPreconditionFailed returns true if the given error is caused by a PreconditionFailedError.
IsServiceUnavailable returns true if the given error is caused by a ServiceUnavailableError.
IsStatusError returns the status code and true if the given error is caused by a StatusError.
IsStatusErrorWithCode returns true if the given error is caused by a StatusError with given code.
NewArangoStarterClient creates a new client implementation.
NewBadRequestError creates a bad request error with given message.
NewInternalServerError creates a internal server error with given message.
NewNotFoundError creates a not found error with given message.
NewPreconditionFailedError creates a precondition failed error with given message.
NewServiceUnavailableError creates a service unavailable error with given message.
ParseResponseError returns an error from given response.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

BadRequestError indicates invalid arguments.
InternalServerError indicates an unspecified error inside the server, perhaps a bug.
PreconditionFailedError indicates that the state of the system is such that the request cannot be executed.
ServiceUnavailableError indicates that right now the service is not available, please retry later.

# Structs

DatabaseVersionResponse is the JSON response of a `/database-version` request.
EndpointList is the JSON response of a `/endpoints` request.
ErrorResponse is the JSON structure returned in an API error.
GoodbyeRequest is the JSON structure send in the request to /goodbye.
IDInfo contains the ID of the starter.
ProcessList is the JSON response of a `/process` request.
ServerProcess holds all information of a single server started by the starter.
StatusError is an error with a given HTTP status code.
UpgradeStatus is the JSON structure returns from a `GET /database-auto-upgrade` request.
UpgradeStatusServer is the nested JSON structure returns from a `GET /database-auto-upgrade` request.
VersionInfo is the JSON response of a `/version` request.

# Interfaces

API is the interface implemented by the starter's HTTP API's.

# Type aliases

ServerType holds a type of (arangod) server.