neo4go

type Decoder interface {
	// DecodeNode takes a node like object (pointers and lists are accepted) and decodes it in the second argument
	DecodeNode(interface{}, interface{}) Neo4GoError

	// DecodeNode takes a relationship like object (pointers and lists are accepted) and decodes it in the second argument
	DecodeRelationship(interface{}, interface{}) Neo4GoError

	// DecodeNode takes a path like object (pointers are accepted) and decodes its nodes in the second argument and its relationships in the third
	DecodePath(interface{}, interface{}, interface{}) Neo4GoError

	// DecodeRecordMap takes a record map and decodes its raw values into the fields of the output
	DecodeRecordMap(RecordMap, interface{}) Neo4GoError
}

type EncodeHookFunc func(reflect.Value, interface{}) (InputStruct, bool)

type Encoder interface {
	// Encode takes any object and encodes it into an object accepted by the neo4go query system
	Encode(interface{}) InputStruct
}

type EncoderOptions struct {
	// The tag name used to find and encode struct fields
	TagName string

	// The function used for every input of this encoder. It is typically a composition of other functions
	EncodeHook EncodeHookFunc

	// Tells if the encoder should be silent or not when it finds an object it cannot decode
	Silent bool
}

type InputOtherType interface {
	InputStruct

	// ConvertToInputObject directly converts the object as an input object?
	ConvertToInputObject() InputStruct
}

type InputStruct interface {
	// ConvertToMap converts this input as a map of query inputs
	ConvertToMap() map[string]InputStruct
}

type Manager interface {
	// IsConnected tells if the driver could effectively connect to the database
	IsConnected() bool

	// Query allows a single query to be made in database, possibly through an existing transaction
	Query(QueryParams) (QueryResult, Neo4GoError)

	// BeginTransaction starts a new transaction and stores it under the returned ID
	BeginTransaction(TransactionParams) (string, Neo4GoError)

	// Commit commits the transaction that has the given ID
	Commit(string) Neo4GoError

	// Rollback rolls back the transaction that has the given ID
	Rollback(string) Neo4GoError

	// LastBookmark returns the bookmark obtained by the session that ran the last query
	LastBookmark() string

	// Close closes the driver
	Close() Neo4GoError
}

type ManagerOptions struct {
	// The full URI to access the database (of the form protocol://domain:port)
	URI string

	// The name of the database to use
	DatabaseName string

	// The realm to use
	Realm string

	// The username to use for accessing the database with basic auth
	Username string

	// The password to use for accessing the database with basic auth
	Password string

	// The auth token used for any other kind of authentication than basic auth
	CustomAuth *neo4j.AuthToken

	// The neo4j configurers to apply to the driver
	Configurers []func(*neo4j.Config)

	// The default formatting to apply to every query of this manager
	DefaultOutputConfig queryOutputFlag
}

type Neo4GoError interface {
	error

	// FmtError returns the formatted error with a prefix
	FmtError() string
}

type QueryParams struct {
	// The cypher query to run in database
	Query string

	// The parameters to apply to this query
	Params map[string]InputStruct

	// The configurers to apply to the query
	Configurers []func(*neo4j.TransactionConfig)

	// The bookmarks of previous sessions to apply to the query
	Bookmarks []string

	// The transaction ID to use for the query
	Transaction string

	// Whether to commit the transaction (if there is one for this query) after the successfull execution of the query
	CommitOnSuccess bool

	// The different configurations to apply to the output of the query
	OutputConfig queryOutputFlag
}

type QueryResult interface {
	// Keys returns the keys available on the result set.
	Keys() ([]string, Neo4GoError)

	// Next returns true only if there is a record to be processed.
	Next() bool

	// Err returns the latest error that caused this Next to return false.
	Err() Neo4GoError

	// Record returns the current typed record.
	Record() (*RecordMap, Neo4GoError)

	// Summary returns the summary information about the statement execution.
	Summary() (neo4j.ResultSummary, Neo4GoError)

	// Consume consumes the entire result and returns the summary information
	// about the statement execution.
	Consume() (neo4j.ResultSummary, Neo4GoError)

	// RawResult allow to retrieve the non-typed neo4j.Result
	RawResult() neo4j.Result
}

type RecordArray interface {
	// Next iterates to the next item of the array and return false if there are no more items
	Next() bool

	// Len returns the length of this array
	Len() int

	// CurrentAsArray returns the current item of the iteration typed as an Array.
	// The second result is a non-nil error if the current item cannot be converted as an Array.
	CurrentAsArray() (RecordArray, Neo4GoError)

	// CurrentAsMap returns the current item of the iteration typed as a Map.
	// The second result is a non-nil error if the current item cannot be converted as a Map.
	CurrentAsMap() (*RecordMap, Neo4GoError)

	// CurrentAsString returns the current item of the iteration typed as a String.
	// The second result is a non-nil error if the current item cannot be converted as a String.
	CurrentAsString() (*string, Neo4GoError)

	// CurrentAsInt returns the current item of the iteration typed as an Int.
	// The second result is a non-nil error if the current item cannot be converted as an Int.
	CurrentAsInt() (*int64, Neo4GoError)

	// CurrentAsFloat returns the current item of the iteration typed as a Float.
	// The second result is a non-nil error if the current item cannot be converted as a Float.
	CurrentAsFloat() (*float64, Neo4GoError)

	// CurrentAsBool returns the current item of the iteration typed as a Bool.
	// The second result is a non-nil error if the current item cannot be converted as a Bool.
	CurrentAsBool() (*bool, Neo4GoError)

	// CurrentAsTime returns the current item of the iteration typed as a Time.
	// The second result is a non-nil error if the current item cannot be converted as a Time.
	CurrentAsTime() (*time.Time, Neo4GoError)

	// CurrentAsNode returns the current item of the iteration typed as a Node.
	// The second result is a non-nil error if the current item cannot be converted as a Node.
	CurrentAsNode() (neo4j.Node, Neo4GoError)

	// CurrentAsRelation returns the current item of the iteration typed as a Relation.
	// The second result is a non-nil error if the current item cannot be converted as a Relation.
	CurrentAsRelation() (neo4j.Relationship, Neo4GoError)

	// CurrentAsPath returns the current item of the iteration typed as a Path.
	// The second result is a non-nil error if the current item cannot be converted as a Path.
	CurrentAsPath() (neo4j.Path, Neo4GoError)

	// CurrentAsInterface returns the current item of the iteration typed as an untyped Interface.
	CurrentAsInterface() interface{}

	// CollectAsArrays returns the whole array of this RecordArray typed as an Array of RecordArray.
	// The second result is a non-nil error if at least one item of the RecordArray cannot be converted as an Array.
	CollectAsArrays() ([]RecordArray, Neo4GoError)

	// CollectAsArrays returns the whole array of this RecordArray typed as an Array of RecordMap.
	// The second result is a non-nil error if at least one item of the RecordArray cannot be converted as a Map.
	CollectAsMaps() ([]RecordMap, Neo4GoError)

	// CollectAsArrays returns the whole array of this RecordArray typed as an Array of string.
	// The second result is a non-nil error if at least one item of the RecordArray cannot be converted as a string.
	CollectAsStrings() ([]string, Neo4GoError)

	// CollectAsArrays returns the whole array of this RecordArray typed as an Array of int64.
	// The second result is a non-nil error if at least one item of the RecordArray cannot be converted as an int64.
	CollectAsInts() ([]int64, Neo4GoError)

	// CollectAsArrays returns the whole array of this RecordArray typed as an Array of float.
	// The second result is a non-nil error if at least one item of the RecordArray cannot be converted as a float.
	CollectAsFloats() ([]float64, Neo4GoError)

	// CollectAsArrays returns the whole array of this RecordArray typed as an Array of bool.
	// The second result is a non-nil error if at least one item of the RecordArray cannot be converted as a bool.
	CollectAsBools() ([]bool, Neo4GoError)

	// CollectAsArrays returns the whole array of this RecordArray typed as an Array of time object.
	// The second result is a non-nil error if at least one item of the RecordArray cannot be converted as a time.Time.
	CollectAsTimes() ([]time.Time, Neo4GoError)

	// CollectAsArrays returns the whole array of this RecordArray typed as an Array of nodes.
	// The second result is a non-nil error if at least one item of the RecordArray cannot be converted as a neo4j.Node.
	CollectAsNodes() ([]neo4j.Node, Neo4GoError)

	// CollectAsArrays returns the whole array of this RecordArray typed as an Array of relationships.
	// The second result is a non-nil error if at least one item of the RecordArray cannot be converted as a neo4j.Relationship.
	CollectAsRelations() ([]neo4j.Relationship, Neo4GoError)

	// CollectAsArrays returns the whole array of this RecordArray typed as an Array of paths.
	// The second result is a non-nil error if at least one item of the RecordArray cannot be converted as a neo4j.Path.
	CollectAsPaths() ([]neo4j.Path, Neo4GoError)

	// CollectAsArrays returns the whole array of this RecordArray typed as an Array of interfaces.
	CollectAsInterfaces() []interface{}

	// CollectAndDecodeAsNodes collects all items of this array and converts them as nodes, then decodes them into the output interface
	CollectAndDecodeAsNodes(Decoder, interface{}) Neo4GoError

	// CollectAndDecodeAsRelations collects all items of this array and converts them as relationships, then decodes them into the output interface
	CollectAndDecodeAsRelations(Decoder, interface{}) Neo4GoError
}

type RecordMap struct {
	Arrays    map[string]RecordArray
	Maps      map[string]RecordMap
	Strings   map[string]string
	Ints      map[string]int64
	Floats    map[string]float64
	Bools     map[string]bool
	Times     map[string]time.Time
	Durations map[string]time.Duration
	Nodes     map[string]neo4j.Node
	Relations map[string]neo4j.Relationship
	Paths     map[string]neo4j.Path
	Others    map[string]interface{}
	// contains filtered or unexported fields
}

type TransactionParams struct {
	// Tells if the transaction type is read or write
	IsWrite bool

	// The bookmarks of previous sessions to apply to the query
	Bookmarks []string

	// The configurers to apply to the transaction
	Configurers []func(*neo4j.TransactionConfig)
}