codium_lib

README

codium_lib

This library is for communication between the database and external programs

Documentation

Overview

Package codium_lib provides a golang interface to the codium database.

Index

• func CreateProject(address, keyStr, projName string) error
• func DeleteProject(address, keyStr, projName string) error
• type Client
  • func NewClient(addr, keyStr, projectName string) Client
  • func (cl Client) CountRows(stmt string) (int64, error)
  • func (cl *Client) CreateTable(stmt string) error
  • func (cl Client) DeleteFields(stmt string, toDeleteFields []string) error
  • func (cl Client) DeleteRows(stmt string) error
  • func (cl *Client) DeleteTable(tableName string) error
  • func (cl *Client) EmptyTable(tableName string) error
  • func (cl *Client) GetCurrentTableDefn(tableName string) (string, error)
  • func (cl *Client) GetCurrentTableDefnParsed(tableName string) (codium_shared.TableDefn, error)
  • func (cl *Client) GetTableDefn(tableName, version string) (string, error)
  • func (cl *Client) GetTableDefnParsed(tableName, version string) (codium_shared.TableDefn, error)
  • func (cl *Client) InsertIntoTable(tableName string, toInsert map[string]interface{}) (int64, error)
  • func (cl Client) ListProjects() ([]string, error)
  • func (cl Client) ListTables() ([]string, error)
  • func (cl *Client) ParseRow(rowStr map[string]string, td codium_shared.TableDefn) (map[string]interface{}, error)
  • func (cl *Client) Ping() error
  • func (cl *Client) RenameProject(projName, newProjName string) error
  • func (cl *Client) RenameTable(tableName, newTableName string) error
  • func (cl *Client) Search(stmt string) (*[]map[string]interface{}, error)
  • func (cl Client) SearchForOne(stmt string) (*map[string]interface{}, error)
  • func (cl Client) SumRows(stmt, toSumField string) (interface{}, error)
  • func (cl Client) UpdateRows(stmt string, updateData map[string]interface{}) error
  • func (cl *Client) UpdateTableDefn(stmt string) error

Functions

func CreateProject

func CreateProject(address, keyStr, projName string) error

A Project is a container of tables

func DeleteProject

func DeleteProject(address, keyStr, projName string) error

Types

type Client

type Client struct {
	Addr        string
	KeyStr      string
	ProjectName string
}

func NewClient

func NewClient(addr, keyStr, projectName string) Client

func (Client) CountRows

func (cl Client) CountRows(stmt string) (int64, error)

func (*Client) CreateTable

func (cl *Client) CreateTable(stmt string) error

func (Client) DeleteFields

func (cl Client) DeleteFields(stmt string, toDeleteFields []string) error

func (Client) DeleteRows

func (cl Client) DeleteRows(stmt string) error

func (*Client) DeleteTable

func (cl *Client) DeleteTable(tableName string) error

func (*Client) EmptyTable

func (cl *Client) EmptyTable(tableName string) error

func (*Client) GetCurrentTableDefn

func (cl *Client) GetCurrentTableDefn(tableName string) (string, error)

func (*Client) GetCurrentTableDefnParsed

func (cl *Client) GetCurrentTableDefnParsed(tableName string) (codium_shared.TableDefn, error)

func (*Client) GetTableDefn

func (cl *Client) GetTableDefn(tableName, version string) (string, error)

func (*Client) GetTableDefnParsed

func (cl *Client) GetTableDefnParsed(tableName, version string) (codium_shared.TableDefn, error)

func (*Client) InsertIntoTable

func (cl *Client) InsertIntoTable(tableName string, toInsert map[string]interface{}) (int64, error)

func (Client) ListProjects

func (cl Client) ListProjects() ([]string, error)

func (Client) ListTables

func (cl Client) ListTables() ([]string, error)

func (*Client) ParseRow

func (cl *Client) ParseRow(rowStr map[string]string, td codium_shared.TableDefn) (map[string]interface{}, error)

ParseRow given a TableDefn would convert a map of strings to a map of interfaces.

func (*Client) Ping

func (cl *Client) Ping() error

Ping checks if the details supplied at the creation of a Client is valid. it returns an error if invalid and nil if not.

func (*Client) RenameProject

func (cl *Client) RenameProject(projName, newProjName string) error

func (*Client) RenameTable

func (cl *Client) RenameTable(tableName, newTableName string) error

func (*Client) Search

func (cl *Client) Search(stmt string) (*[]map[string]interface{}, error)

func (Client) SearchForOne

func (cl Client) SearchForOne(stmt string) (*map[string]interface{}, error)

func (Client) SumRows

func (cl Client) SumRows(stmt, toSumField string) (interface{}, error)

Sums the fields of a row and returns int64 if it is an int field or float64 if it a float field.

func (Client) UpdateRows

func (cl Client) UpdateRows(stmt string, updateData map[string]interface{}) error

func (*Client) UpdateTableDefn

func (cl *Client) UpdateTableDefn(stmt string) error

If you wanted to only rename the table, use RenameTable instead.