gnosql_client

package module
v1.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 23, 2023 License: MIT Imports: 8 Imported by: 0

README

GnoSQL Client for GnoSQL In-Memory Database

GnoSQL Client is a Go library that provides a client for interacting with the GnoSQL in-memory database. It simplifies the process of managing connections, executing queries, and working with data in a GnoSQL database.

License

Features

  • Connection Management: Easily connect to a Gnosql in-memory database.
  • Query Execution: Execute queries and retrieve results.
  • Data Manipulation: Perform CRUD operations on your Gnosql database.
  • Documentation: Well-documented code and usage examples.

Installation

go get -u github.com/nanda03dev/gnosql_client

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var COLLECTION_CREATE_SUCCESS_MSG = "Collection created successfully"
View Source 
var COLLECTION_DELETE_SUCCESS_MSG = "Collection deleted successfully"
View Source 
var COLLECTION_NOT_FOUND_MSG = "Collection not found "
View Source 
var DATABASE_ALREADY_EXISTS_MSG = "Database already exists"
View Source 
var DATABASE_CREATE_SUCCESS_MSG = "Database created successfully"
View Source 
var DATABASE_DELETE_SUCCESS_MSG = "Database deleted successfully"
View Source 
var DATABASE_LOAD_TO_DISK_MSG = "Database to file disk process started"
View Source 
var DATABASE_NOT_FOUND_MSG = "Database not found"
View Source 
var DOCUMENT_DELETE_SUCCESS_MSG = "Document deleted successfully"
View Source 
var DOCUMENT_NOT_FOUND_MSG = "Document not found"
View Source 
var ERROR_WHILE_BINDING_JSON = "Request JSON binding failed"
View Source 
var ERROR_WHILE_MARSHAL_JSON = "Request JSON Marhsall failed"
View Source 
var ERROR_WHILE_UNMARSHAL_JSON = "Request JSON Unmarhsall failed"
View Source 
var EndpointsMap = Endpoints{
	DatabaseGetAll: "database/get-all",
	DatabaseAdd:    "database/add",
	DatabaseDelete: "database/delete",
	Collection:     "collection",
	Document:       "document",
}

Functions

func CreateCollectionsInstance added in v1.0.2 

func CreateCollectionsInstance(database *Database, collections []CollectionInput)

func DeleteCollectionInstances added in v1.0.2 

func DeleteCollectionInstances(database *Database, collections []string)

func ValidateResponse 

func ValidateResponse(restyErr error, UnMarshallErr error, gRPCErr error, gRestResponseErr string) string

Types

type Client 

type Client struct {
	URI        string // Ex: http://localhost:5454
	IsgRPC     bool
	ClientgRPC pb.GnoSQLServiceClient
	DB         map[string]*Database
}

func Connect 

func Connect(URI string, isgRPC bool) *Client

Create new GnoSQL client, URI string Ex: http://localhost:5454

func (*Client) Create 

func (client *Client) Create(databaseName string, collections []CollectionInput) DatabaseCreateResult

return { Data : "Sucess message", Error: "Error message" }, error

func (*Client) Delete 

func (client *Client) Delete(databaseName string) DatabaseDeleteResult

return { Data : "Sucess message", Error: "Error message" }, error

func (*Client) GetAll 

func (client *Client) GetAll() DatabaseGetAllResult

return { Data : [DatabaseName1, DatabaseName2...], Error: "Error message" }, error

type Collection 

type Collection struct {
	URI            string
	CollectionName string
	DBName         string
	IsgRPC         bool
	ClientgRPC     pb.GnoSQLServiceClient
}

Collection Types

func (*Collection) Create 

func (collection *Collection) Create(document Document) DocumentCreateResult

return { Data : Document, Error: "Error message" }, error

func (*Collection) Delete 

func (collection *Collection) Delete(id string) DocumentDeleteResult

return { Data : "Success Message", Error: "Error message" }, error

func (*Collection) Filter 

func (collection *Collection) Filter(filter DocumentFilterQuery) DocumentFilterResult

return { Data : []Document, Error: "Error message" }, error

func (*Collection) GetAll added in v1.0.2 

func (collection *Collection) GetAll() DocumentGetAllResult

return { Data : Document, Error: "Error message" }, error

func (*Collection) Read 

func (collection *Collection) Read(id string) DocumentReadResult

return { Data : Document, Error: "Error message" }, error

func (*Collection) Update 

func (collection *Collection) Update(id string, document Document) DocumentUpdateResult

return { Data : Document, Error: "Error message" }, error

type CollectionCreateResult 

type CollectionCreateResult struct {
	Data  string // Data : collection created succesfully
	Error string
}

func GRPC_Create_Collections added in v1.0.2 

func GRPC_Create_Collections(database *Database, requestBody *pb.CollectionCreateRequest) CollectionCreateResult

func REST_Create_Collections added in v1.0.2 

func REST_Create_Collections(database *Database, requestBody interface{}) CollectionCreateResult

type CollectionDeleteInput 

type CollectionDeleteInput struct {
	Collections []string
}

type CollectionDeleteResult 

type CollectionDeleteResult struct {
	Data  string // Data : collection deleted succesfully
	Error string
}

func GRPC_Delete_Collections added in v1.0.2 

func GRPC_Delete_Collections(database *Database, requestBody *pb.CollectionDeleteRequest) CollectionDeleteResult

func REST_Delete_Collections added in v1.0.2 

func REST_Delete_Collections(database *Database, requestBody interface{}) CollectionDeleteResult

type CollectionGetAllResult 

type CollectionGetAllResult struct {
	Data  []string // List of collection names [collection1, collection2...]
	Error string
}

func GRPC_GetAll_Collections added in v1.0.2 

func GRPC_GetAll_Collections(database *Database, requestBody *pb.CollectionGetAllRequest) CollectionGetAllResult

func REST_GetAll_Collections added in v1.0.2 

func REST_GetAll_Collections(database *Database) CollectionGetAllResult

type CollectionInput 

type CollectionInput struct {
	CollectionName string
	IndexKeys      []string
}

type CollectionStats 

type CollectionStats struct {
	CollectionName string
	IndexKeys      []string
	Documents      int32
}

type CollectionStatsResult 

type CollectionStatsResult struct {
	Data  CollectionStats
	Error string
}

func GRPC_Get_Collection_Stats added in v1.0.2 

func GRPC_Get_Collection_Stats(database *Database, requestBody *pb.CollectionStatsRequest) CollectionStatsResult

func REST_GetAll_Collection_Stats added in v1.0.2 

func REST_GetAll_Collection_Stats(database *Database, collectionName string) CollectionStatsResult

type Database 

type Database struct {
	URI         string
	DBName      string
	IsgRPC      bool
	ClientgRPC  pb.GnoSQLServiceClient
	Collections map[string]*Collection
}

func CreateDatabaseInstance added in v1.0.2 

func CreateDatabaseInstance(client *Client, DatabaseName string) *Database

func (*Database) CreateCollections 

func (database *Database) CreateCollections(collections []CollectionInput) CollectionCreateResult

return { Data : "Success Message", Error: "Error message" }, error

func (*Database) DeleteCollections 

func (database *Database) DeleteCollections(collectionDeleteInput CollectionDeleteInput) CollectionDeleteResult

return { Data : "Success Message", Error: "Error message" }, error

func (*Database) GetAll 

func (database *Database) GetAll() CollectionGetAllResult

return { Data : [collection1, collection2...], Error: "Error message" }, error

func (*Database) GetCollectionStats 

func (database *Database) GetCollectionStats(collectionName string) CollectionStatsResult

return { Data : { CollectionName string, IndexKeys []string, Documents int} , Error: "Error message" }, error

type DatabaseCreateInput 

type DatabaseCreateInput struct {
	DatabaseName string
}

type DatabaseCreateResult 

type DatabaseCreateResult struct {
	Data  string // Data : database created succesfully
	Error string
}

func GRPC_Create_DB added in v1.0.2 

func GRPC_Create_DB(client *Client, requestBody *pb.DatabaseCreateRequest) DatabaseCreateResult

func REST_Create_DB added in v1.0.2 

func REST_Create_DB(client *Client, requestBody interface{}) DatabaseCreateResult

type DatabaseDeleteResult 

type DatabaseDeleteResult struct {
	Data  string // Data : database deleted succesfully
	Error string
}

func GRPC_Delete_DB added in v1.0.2 

func GRPC_Delete_DB(client *Client, requestBody *pb.DatabaseDeleteRequest) DatabaseDeleteResult

func REST_Delete_DB added in v1.0.2 

func REST_Delete_DB(client *Client, requestBody interface{}) DatabaseDeleteResult

type DatabaseGetAllResult 

type DatabaseGetAllResult struct {
	Data  []string // List of database names [DatabaseName1, DatabaseName2...]
	Error string
}

func GRPC_GetAll_DB added in v1.0.2 

func GRPC_GetAll_DB(client *Client) DatabaseGetAllResult

func REST_GetAll_DB added in v1.0.2 

func REST_GetAll_DB(client *Client) DatabaseGetAllResult

type Document 

type Document map[string]interface{}

Document types

type DocumentCreateResult 

type DocumentCreateResult struct {
	Data  Document // Data : Document
	Error string
}

func GRPC_Create_Document added in v1.0.2 

func GRPC_Create_Document(collection *Collection, document Document) DocumentCreateResult

func REST_Create_Document added in v1.0.2 

func REST_Create_Document(collection *Collection, document Document) DocumentCreateResult

type DocumentDeleteResult 

type DocumentDeleteResult struct {
	Data  string // Data : document deleted succesfully
	Error string
}

func GRPC_Delete_Document added in v1.0.2 

func GRPC_Delete_Document(collection *Collection, id string) DocumentDeleteResult

func REST_Delete_Document added in v1.0.2 

func REST_Delete_Document(collection *Collection, id string) DocumentDeleteResult

type DocumentFilterQuery 

type DocumentFilterQuery map[string]interface{}

type DocumentFilterResult 

type DocumentFilterResult struct {
	Data  []Document // List of documents [Document, Document...]
	Error string
}

func GRPC_Filter_Document added in v1.0.2 

func GRPC_Filter_Document(collection *Collection, filter DocumentFilterQuery) DocumentFilterResult

func REST_Filter_Document added in v1.0.2 

func REST_Filter_Document(collection *Collection, filter DocumentFilterQuery) DocumentFilterResult

type DocumentGetAllResult added in v1.0.2 

type DocumentGetAllResult struct {
	Data  []Document // List of documents [Document, Document...]
	Error string
}

func GRPC_GetAll_Document added in v1.0.2 

func GRPC_GetAll_Document(collection *Collection) DocumentGetAllResult

func REST_GetAll_Document added in v1.0.2 

func REST_GetAll_Document(collection *Collection) DocumentGetAllResult

type DocumentReadResult 

type DocumentReadResult struct {
	Data  Document // Data : Document
	Error string
}

func GRPC_Read_Document added in v1.0.2 

func GRPC_Read_Document(collection *Collection, id string) DocumentReadResult

func REST_Read_Document added in v1.0.2 

func REST_Read_Document(collection *Collection, id string) DocumentReadResult

type DocumentUpdateResult 

type DocumentUpdateResult struct {
	Data  Document // Data : Document
	Error string
}

func GRPC_Update_Document added in v1.0.2 

func GRPC_Update_Document(collection *Collection, id string, document Document) DocumentUpdateResult

func REST_Update_Document added in v1.0.2 

func REST_Update_Document(collection *Collection, id string, document Document) DocumentUpdateResult

type Endpoints 

type Endpoints struct {
	DatabaseGetAll string
	DatabaseAdd    string
	DatabaseDelete string
	Collection     string
	Document       string
}

type ReqBody 

type ReqBody map[string]interface{}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.