Documentation
¶
Index ¶
- Constants
- Variables
- type ArangoCollection
- func (instance *ArangoCollection) Count() (int64, error)
- func (instance *ArangoCollection) Drop() (bool, error)
- func (instance *ArangoCollection) EnsureGeoIndex(fields []string, geoJson bool) (bool, error)
- func (instance *ArangoCollection) EnsureIndex(fields []string, unique bool) (bool, error)
- func (instance *ArangoCollection) Exists(key string) (bool, error)
- func (instance *ArangoCollection) Insert(doc map[string]interface{}) (map[string]interface{}, driver.DocumentMeta, error)
- func (instance *ArangoCollection) InsertDocument(doc interface{}) (interface{}, driver.DocumentMeta, error)
- func (instance *ArangoCollection) IsReady() bool
- func (instance *ArangoCollection) Name() string
- func (instance *ArangoCollection) Native() driver.Collection
- func (instance *ArangoCollection) Read(key string) (map[string]interface{}, driver.DocumentMeta, error)
- func (instance *ArangoCollection) Remove(key string) (driver.DocumentMeta, error)
- func (instance *ArangoCollection) RemoveGeoIndex(fields []string) (bool, error)
- func (instance *ArangoCollection) RemoveIndex(fields []string) (bool, error)
- func (instance *ArangoCollection) Update(doc map[string]interface{}) (map[string]interface{}, driver.DocumentMeta, error)
- func (instance *ArangoCollection) UpdateDocument(key string, doc interface{}) (interface{}, driver.DocumentMeta, error)
- func (instance *ArangoCollection) Upsert(doc map[string]interface{}) (map[string]interface{}, driver.DocumentMeta, error)
- type ArangoConfig
- type ArangoConfigAuth
- type ArangoConnection
- func (instance *ArangoConnection) Database(name string, createIfNotExists bool) (response *ArangoDatabase, err error)
- func (instance *ArangoConnection) DropDatabase(name string) (success bool, err error)
- func (instance *ArangoConnection) IsReady() bool
- func (instance *ArangoConnection) Open() (err error)
- type ArangoDatabase
- func (instance *ArangoDatabase) Collection(name string, createIfNotExists bool) (*ArangoCollection, error)
- func (instance *ArangoDatabase) CollectionAutoCreate(name string) (*ArangoCollection, error)
- func (instance *ArangoDatabase) CollectionExists(name string) (bool, error)
- func (instance *ArangoDatabase) CollectionNames() ([]string, error)
- func (instance *ArangoDatabase) Count(query string, bindVars map[string]interface{}) (int64, error)
- func (instance *ArangoDatabase) Drop() (bool, error)
- func (instance *ArangoDatabase) ImportFile(fileName string) error
- func (instance *ArangoDatabase) ImportFiles(fileNames []string) error
- func (instance *ArangoDatabase) IsReady() bool
- func (instance *ArangoDatabase) Name() string
- func (instance *ArangoDatabase) Native() driver.Database
- func (instance *ArangoDatabase) Query(query string, bindVars map[string]interface{}, callback QueryCallback) error
- type QueryCallback
Constants ¶
View Source
const KeyFieldName = "_key" // all entities should have this field
Variables ¶
View Source
var ( ErrMissingConfiguration = errors.New("missing_configuration") ErrConnectionNotReady = errors.New("connection_not_ready") ErrDatabaseDoesNotExists = errors.New("database_does_not_exists") ErrCollectionDoesNotExists = errors.New("collection_does_not_exists") ErrMissingDocumentKey = errors.New("document_missing_key") )
Functions ¶
This section is empty.
Types ¶
type ArangoCollection ¶
type ArangoCollection struct {
// contains filtered or unexported fields
}
func (*ArangoCollection) Count ¶
func (instance *ArangoCollection) Count() (int64, error)
func (*ArangoCollection) Drop ¶
func (instance *ArangoCollection) Drop() (bool, error)
func (*ArangoCollection) EnsureGeoIndex ¶
func (instance *ArangoCollection) EnsureGeoIndex(fields []string, geoJson bool) (bool, error)
func (*ArangoCollection) EnsureIndex ¶
func (instance *ArangoCollection) EnsureIndex(fields []string, unique bool) (bool, error)
func (*ArangoCollection) Exists ¶
func (instance *ArangoCollection) Exists(key string) (bool, error)
func (*ArangoCollection) Insert ¶
func (instance *ArangoCollection) Insert(doc map[string]interface{}) (map[string]interface{}, driver.DocumentMeta, error)
func (*ArangoCollection) InsertDocument ¶
func (instance *ArangoCollection) InsertDocument(doc interface{}) (interface{}, driver.DocumentMeta, error)
func (*ArangoCollection) IsReady ¶
func (instance *ArangoCollection) IsReady() bool
func (*ArangoCollection) Name ¶
func (instance *ArangoCollection) Name() string
func (*ArangoCollection) Native ¶
func (instance *ArangoCollection) Native() driver.Collection
func (*ArangoCollection) Read ¶
func (instance *ArangoCollection) Read(key string) (map[string]interface{}, driver.DocumentMeta, error)
func (*ArangoCollection) Remove ¶
func (instance *ArangoCollection) Remove(key string) (driver.DocumentMeta, error)
func (*ArangoCollection) RemoveGeoIndex ¶
func (instance *ArangoCollection) RemoveGeoIndex(fields []string) (bool, error)
func (*ArangoCollection) RemoveIndex ¶
func (instance *ArangoCollection) RemoveIndex(fields []string) (bool, error)
func (*ArangoCollection) Update ¶
func (instance *ArangoCollection) Update(doc map[string]interface{}) (map[string]interface{}, driver.DocumentMeta, error)
func (*ArangoCollection) UpdateDocument ¶
func (instance *ArangoCollection) UpdateDocument(key string, doc interface{}) (interface{}, driver.DocumentMeta, error)
func (*ArangoCollection) Upsert ¶
func (instance *ArangoCollection) Upsert(doc map[string]interface{}) (map[string]interface{}, driver.DocumentMeta, error)
type ArangoConfig ¶
type ArangoConfig struct {
Endpoints []string `json:"endpoints"`
Authentication *ArangoConfigAuth `json:"authentication"`
}
func NewArangoConfig ¶
func NewArangoConfig() *ArangoConfig
func (*ArangoConfig) Parse ¶
func (instance *ArangoConfig) Parse(text string) error
func (*ArangoConfig) ToString ¶
func (instance *ArangoConfig) ToString() string
type ArangoConfigAuth ¶
type ArangoConnection ¶
type ArangoConnection struct {
Config *ArangoConfig
Version string
Server string
License string
// contains filtered or unexported fields
}
func NewArangoConnection ¶
func NewArangoConnection(config *ArangoConfig) *ArangoConnection
func (*ArangoConnection) Database ¶
func (instance *ArangoConnection) Database(name string, createIfNotExists bool) (response *ArangoDatabase, err error)
func (*ArangoConnection) DropDatabase ¶
func (instance *ArangoConnection) DropDatabase(name string) (success bool, err error)
func (*ArangoConnection) IsReady ¶
func (instance *ArangoConnection) IsReady() bool
func (*ArangoConnection) Open ¶
func (instance *ArangoConnection) Open() (err error)
type ArangoDatabase ¶
type ArangoDatabase struct {
// contains filtered or unexported fields
}
func (*ArangoDatabase) Collection ¶
func (instance *ArangoDatabase) Collection(name string, createIfNotExists bool) (*ArangoCollection, error)
func (*ArangoDatabase) CollectionAutoCreate ¶
func (instance *ArangoDatabase) CollectionAutoCreate(name string) (*ArangoCollection, error)
func (*ArangoDatabase) CollectionExists ¶
func (instance *ArangoDatabase) CollectionExists(name string) (bool, error)
func (*ArangoDatabase) CollectionNames ¶
func (instance *ArangoDatabase) CollectionNames() ([]string, error)
func (*ArangoDatabase) Count ¶
func (instance *ArangoDatabase) Count(query string, bindVars map[string]interface{}) (int64, error)
func (*ArangoDatabase) Drop ¶
func (instance *ArangoDatabase) Drop() (bool, error)
func (*ArangoDatabase) ImportFile ¶
func (instance *ArangoDatabase) ImportFile(fileName string) error
func (*ArangoDatabase) ImportFiles ¶
func (instance *ArangoDatabase) ImportFiles(fileNames []string) error
func (*ArangoDatabase) IsReady ¶
func (instance *ArangoDatabase) IsReady() bool
func (*ArangoDatabase) Name ¶
func (instance *ArangoDatabase) Name() string
func (*ArangoDatabase) Native ¶
func (instance *ArangoDatabase) Native() driver.Database
func (*ArangoDatabase) Query ¶
func (instance *ArangoDatabase) Query(query string, bindVars map[string]interface{}, callback QueryCallback) error
type QueryCallback ¶
type QueryCallback func(driver.DocumentMeta, interface{}, error) bool
Click to show internal directories.
Click to hide internal directories.