//
// DatabaseExists is a server-level command, so must be preceded by calling
// ConnectToServer, otherwise an authorization error will be returned.
// The storageType param must be either PersistentStorageType or VolatileStorageType.
//
func DatabaseExists(dbc *DBClient, dbname string, storageType constants.StorageType) (bool, error) {
dbc.buf.Reset()
if dbc.sessionId == NoSessionID {
return false, oerror.SessionNotInitialized{}
}
// cmd
err := rw.WriteByte(dbc.buf, REQUEST_DB_EXIST)
if err != nil {
return false, err
}
// session id
err = rw.WriteInt(dbc.buf, dbc.sessionId)
if err != nil {
return false, err
}
// database name, storage-type
err = rw.WriteStrings(dbc.buf, dbname, string(storageType))
if err != nil {
return false, err
}
// send to the OrientDB server
_, err = dbc.conx.Write(dbc.buf.Bytes())
if err != nil {
return false, err
}
/* ---[ Read Response From Server ]--- */
status, err := rw.ReadByte(dbc.conx)
if err != nil {
return false, err
}
err = readAndValidateSessionId(dbc.conx, dbc.sessionId)
if err != nil {
return false, err
}
if status == RESPONSE_STATUS_ERROR {
serverExceptions, err := rw.ReadErrorResponse(dbc.conx)
if err != nil {
return false, err
}
return false, fmt.Errorf("Server Error(s): %v", serverExceptions)
}
// the answer to the query
dbexists, err := rw.ReadBool(dbc.conx)
if err != nil {
return false, err
}
return dbexists, nil
}
//
// CreateDatabase will create a `remote` database of the type and storageType specified.
// dbType must be type DocumentDBType or GraphDBType.
// storageType must type PersistentStorageType or VolatileStorageType.
//
func CreateDatabase(dbc *DBClient, dbname string, dbtype constants.DatabaseType, storageType constants.StorageType) error {
dbc.buf.Reset()
/* ---[ precondition checks ]--- */
// TODO: may need to change this to serverSessionid (can the "sessionId" be used for both server connections and db conx?)
if dbc.sessionId == NoSessionID {
return oerror.SessionNotInitialized{}
}
/* ---[ build request and send to server ]--- */
// cmd
err := rw.WriteByte(dbc.buf, REQUEST_DB_CREATE)
if err != nil {
return err
}
// session id
err = rw.WriteInt(dbc.buf, dbc.sessionId)
if err != nil {
return err
}
err = rw.WriteStrings(dbc.buf, dbname, string(dbtype), string(storageType))
if err != nil {
return err
}
// send to the OrientDB server
_, err = dbc.conx.Write(dbc.buf.Bytes())
if err != nil {
return err
}
/* ---[ read response from server ]--- */
status, err := rw.ReadByte(dbc.conx)
if err != nil {
return err
}
err = readAndValidateSessionId(dbc.conx, dbc.sessionId)
if err != nil {
return err
}
if status == RESPONSE_STATUS_ERROR {
serverExceptions, err := rw.ReadErrorResponse(dbc.conx)
if err != nil {
return err
}
return fmt.Errorf("Server Error(s): %v", serverExceptions)
}
return nil
}
//
// DropDatabase drops the specified database. The caller must provide
// both the name and the type of the database. The type should either:
//
// obinary.DocumentDBType
// obinary.GraphDBType
//
// This is a "server" command, so you must have already called
// ConnectToServer before calling this function.
//
func DropDatabase(dbc *DBClient, dbname string, dbtype constants.DatabaseType) error {
dbc.buf.Reset()
if dbc.sessionId == NoSessionID {
return oerror.SessionNotInitialized{}
}
// cmd
err := rw.WriteByte(dbc.buf, REQUEST_DB_DROP)
if err != nil {
return err
}
// session id
err = rw.WriteInt(dbc.buf, dbc.sessionId)
if err != nil {
return err
}
// database name, storage-type
err = rw.WriteStrings(dbc.buf, dbname, string(dbtype))
if err != nil {
return err
}
// send to the OrientDB server
_, err = dbc.conx.Write(dbc.buf.Bytes())
if err != nil {
return err
}
/* ---[ read response from server ]--- */
status, err := rw.ReadByte(dbc.conx)
if err != nil {
return err
}
err = readAndValidateSessionId(dbc.conx, dbc.sessionId)
if err != nil {
return err
}
if status == RESPONSE_STATUS_ERROR {
serverExceptions, err := rw.ReadErrorResponse(dbc.conx)
if err != nil {
return err
}
return fmt.Errorf("Server Error(s): %v", serverExceptions)
}
return nil
}
//
// SQLQuery
//
// TODO: right now I return the entire resultSet as an array, thus all loaded into memory
// it would be better to have obinary.dbCommands provide an iterator based model
// that only needs to read a "row" (ODocument) at a time
// Perhaps SQLQuery() -> iterator/cursor
// SQLQueryGetAll() -> []*ODocument ??
//
func SQLQuery(dbc *DBClient, sql string, fetchPlan string, params ...string) ([]*oschema.ODocument, error) {
dbc.buf.Reset()
err := writeCommandAndSessionId(dbc, REQUEST_COMMAND)
if err != nil {
return nil, oerror.NewTrace(err)
}
mode := byte('s') // synchronous only supported for now
err = rw.WriteByte(dbc.buf, mode)
if err != nil {
return nil, oerror.NewTrace(err)
}
// need a separate buffer to write the command-payload to, so
// we can calculate its length before writing it to main dbc.buf
commandBuf := new(bytes.Buffer)
err = rw.WriteStrings(commandBuf, "q", sql) // q for query
if err != nil {
return nil, oerror.NewTrace(err)
}
// non-text-limit (-1 = use limit from query text)
err = rw.WriteInt(commandBuf, -1)
if err != nil {
return nil, oerror.NewTrace(err)
}
// fetch plan
err = rw.WriteString(commandBuf, fetchPlan)
if err != nil {
return nil, oerror.NewTrace(err)
}
serializedParams, err := serializeSimpleSQLParams(dbc, params)
if err != nil {
return nil, oerror.NewTrace(err)
}
if serializedParams != nil {
rw.WriteBytes(commandBuf, serializedParams)
}
serializedCmd := commandBuf.Bytes()
// command-payload-length and command-payload
err = rw.WriteBytes(dbc.buf, serializedCmd)
if err != nil {
return nil, oerror.NewTrace(err)
}
// send to the OrientDB server
finalBytes := dbc.buf.Bytes()
_, err = dbc.conx.Write(finalBytes)
if err != nil {
return nil, oerror.NewTrace(err)
}
/* ---[ Read Response ]--- */
err = readStatusCodeAndSessionId(dbc)
if err != nil {
return nil, oerror.NewTrace(err)
}
resType, err := rw.ReadByte(dbc.conx)
if err != nil {
return nil, oerror.NewTrace(err)
}
resultType := int32(resType)
var docs []*oschema.ODocument
if resultType == 'n' {
// NOTE: OStorageRemote in Java client just sets result to null and moves on
ogl.Warn("Result type in SQLQuery is 'n' -> what to do? nothing ???") // DEBUG
} else if resultType == 'r' {
ogl.Warn("NOTE NOTE NOTE: this path has NOT YET BEEN TESTED") // DEBUG
doc, err := readSingleRecord(dbc)
if err != nil {
return nil, oerror.NewTrace(err)
}
docs = append(docs, doc)
} else if resultType == 'l' {
docs, err = readResultSet(dbc)
if err != nil {
return nil, oerror.NewTrace(err)
}
} else {
// TODO: I've not yet tested this route of code -> how do so?
ogl.Warn(">> Not yet supported")
ogl.Fatal(fmt.Sprintf("NOTE NOTE NOTE: testing the resultType == '%v' (else) route of code -- "+
"remove this note and test it!!", string(resultType)))
}
// any additional records are "supplementary" - from the fetchPlan these
// need to be hydrated into ODocuments and then put into the primary Docs
if dbc.binaryProtocolVersion >= int16(17) { // copied from the OrientDB 2.x Java client
end, err := rw.ReadByte(dbc.conx)
if err != nil {
return nil, oerror.NewTrace(err)
}
if end != byte(0) {
mapRIDToDoc, err := readSupplementaryRecords(dbc)
if err != nil {
return nil, oerror.NewTrace(err)
}
addSupplementaryRecsToPrimaryRecs(docs, mapRIDToDoc)
}
}
return docs, nil
}
//
// SQLCommand executes SQL commands that are not queries. Any SQL statement
// that does not being with "SELECT" should be sent here. All SELECT
// statements should go to the SQLQuery function.
//
// Commands can be optionally paramterized using ?, such as:
//
// INSERT INTO Foo VALUES(a, b, c) (?, ?, ?)
//
// The values for the placeholders (currently) must be provided as strings.
//
// Constraints (for now):
// 1. cmds with only simple positional parameters allowed
// 2. cmds with lists of parameters ("complex") NOT allowed
// 3. parameter types allowed: string only for now
//
// SQL commands in OrientDB tend to return one of two types - a string return value or
// one or more documents. The meaning are specific to the type of query.
//
// ----------------
// For example:
// ----------------
// for a DELETE statement:
// retval = number of rows deleted (as a string)
// docs = empty list
//
// for an INSERT statement:
// n = ?
// docs = ?
//
// for an CREATE CLASS statement:
// retval = cluster id of the class (TODO: or it might be number of classes in cluster)
// docs = empty list
//
// for an DROP CLASS statement:
// retval = "true" if successful, "" if class didn't exist (technically it returns null)
// docs = empty list
//
func SQLCommand(dbc *DBClient, sql string, params ...string) (retval string, docs []*oschema.ODocument, err error) {
dbc.buf.Reset()
err = writeCommandAndSessionId(dbc, REQUEST_COMMAND)
if err != nil {
return "", nil, oerror.NewTrace(err)
}
mode := byte('s') // synchronous only supported for now
err = rw.WriteByte(dbc.buf, mode)
if err != nil {
return "", nil, oerror.NewTrace(err)
}
// need a separate buffer to write the command-payload to, so
// we can calculate its length before writing it to main dbc.buf
commandBuf := new(bytes.Buffer)
// "classname" (command-type, really) and the sql command
err = rw.WriteStrings(commandBuf, "c", sql) // c for command(non-idempotent)
if err != nil {
return "", nil, oerror.NewTrace(err)
}
// SQLCommand
// (text:string)
// (has-simple-parameters:boolean)
// (simple-paremeters:bytes[]) -> serialized Map (EMBEDDEDMAP??)
// (has-complex-parameters:boolean)
// (complex-parameters:bytes[]) -> serialized Map (EMBEDDEDMAP??)
serializedParams, err := serializeSimpleSQLParams(dbc, params)
if err != nil {
return "", nil, oerror.NewTrace(err)
}
// has-simple-parameters
err = rw.WriteBool(commandBuf, serializedParams != nil)
if err != nil {
return "", nil, oerror.NewTrace(err)
}
if serializedParams != nil {
rw.WriteBytes(commandBuf, serializedParams)
}
// FIXME: no complex parameters yet since I don't understand what they are
// has-complex-paramters => HARDCODING FALSE FOR NOW
err = rw.WriteBool(commandBuf, false)
if err != nil {
return "", nil, oerror.NewTrace(err)
}
serializedCmd := commandBuf.Bytes()
// command-payload-length and command-payload
err = rw.WriteBytes(dbc.buf, serializedCmd)
if err != nil {
return "", nil, oerror.NewTrace(err)
}
// send to the OrientDB server
_, err = dbc.conx.Write(dbc.buf.Bytes())
if err != nil {
return "", nil, oerror.NewTrace(err)
}
/* ---[ Read Response ]--- */
err = readStatusCodeAndSessionId(dbc)
if err != nil {
return "", nil, oerror.NewTrace(err)
}
// for synchronous commands the remaining content is an array of form:
// [(synch-result-type:byte)[(synch-result-content:?)]]+
// so the final value will by byte(0) to indicate the end of the array
// and we must use a loop here
for {
resType, err := rw.ReadByte(dbc.conx)
if err != nil {
return "", nil, oerror.NewTrace(err)
}
// This implementation assumes that SQLCommand can never have "supplementary records"
// from an extended fetchPlan
if resType == byte(0) {
break
}
resultType := rune(resType)
ogl.Debugf("resultType for SQLCommand: %v (%s)\n", resultType, string(rune(resultType)))
if resultType == 'n' { // null result
// do nothing - anything need to be done here?
} else if resultType == 'r' { // single record
doc, err := readSingleRecord(dbc)
if err != nil {
return "", nil, oerror.NewTrace(err)
}
ogl.Debugf("r>doc = %v\n", doc) // DEBUG
if doc != nil {
docs = make([]*oschema.ODocument, 1)
docs[0] = doc
}
} else if resultType == 'l' { // collection of records
ogl.Debugln("... resultType l")
collectionDocs, err := readResultSet(dbc)
if err != nil {
return "", nil, oerror.NewTrace(err)
}
if docs == nil {
docs = collectionDocs
} else {
docs = append(docs, collectionDocs...)
}
} else if resultType == 'a' { // serialized type
serializedRec, err := rw.ReadBytes(dbc.conx)
if err != nil {
return "", nil, oerror.NewTrace(err)
}
// TODO: for now I'm going to assume that this always just returns a string
// need a use case that violates this assumption
retval = string(serializedRec)
if err != nil {
return "", nil, oerror.NewTrace(err)
}
} else {
_, file, line, _ := runtime.Caller(0)
// TODO: I've not yet tested this route of code -> how do so?
ogl.Warnf(">> Got back resultType %v (%v): Not yet supported: line:%d; file:%s\n",
resultType, string(rune(resultType)), line, file)
// TODO: returning here is NOT the correct long-term behavior
return "", nil, fmt.Errorf("Got back resultType %v (%v): Not yet supported: line:%d; file:%s\n",
resultType, string(rune(resultType)), line, file)
}
}
return retval, docs, err
}
//
// OpenDatabase sends the REQUEST_DB_OPEN command to the OrientDB server to
// open the db in read/write mode. The database name and type are required, plus
// username and password. Database type should be one of the obinary constants:
// DocumentDBType or GraphDBType.
//
func OpenDatabase(dbc *DBClient, dbname string, dbtype constants.DatabaseType, username, passw string) error {
buf := dbc.buf
buf.Reset()
// first byte specifies request type
err := rw.WriteByte(buf, REQUEST_DB_OPEN)
if err != nil {
return oerror.NewTrace(err)
}
// session-id - send a negative number to create a new server-side conx
err = rw.WriteInt(buf, RequestNewSession)
if err != nil {
return oerror.NewTrace(err)
}
err = rw.WriteStrings(buf, DriverName, DriverVersion)
if err != nil {
return oerror.NewTrace(err)
}
err = rw.WriteShort(buf, dbc.binaryProtocolVersion)
if err != nil {
return oerror.NewTrace(err)
}
// dbclient id - send as null, but cannot be null if clustered config
// TODO: change to use dbc.clusteredConfig once that is added
err = rw.WriteNull(buf)
if err != nil {
return oerror.NewTrace(err)
}
// serialization-impl
err = rw.WriteString(buf, dbc.serializationType)
if err != nil {
return oerror.NewTrace(err)
}
// token-session // TODO: hardcoded as false for now -> change later based on ClientOptions settings
err = rw.WriteBool(buf, false)
if err != nil {
return oerror.NewTrace(err)
}
// dbname, dbtype, username, password
err = rw.WriteStrings(buf, dbname, string(dbtype), username, passw)
if err != nil {
return oerror.NewTrace(err)
}
// now send to the OrientDB server
_, err = dbc.conx.Write(buf.Bytes())
if err != nil {
return oerror.NewTrace(err)
}
/* ---[ read back response ]--- */
// first byte indicates success/error
status, err := rw.ReadByte(dbc.conx)
if err != nil {
return oerror.NewTrace(err)
}
dbc.currDB = NewDatabase(dbname, dbtype)
// the first int returned is the session id sent - which was the `RequestNewSession` sentinel
sessionValSent, err := rw.ReadInt(dbc.conx)
if err != nil {
return oerror.NewTrace(err)
}
if sessionValSent != RequestNewSession {
return errors.New("Unexpected Error: Server did not return expected session-request-val that was sent")
}
// if status returned was ERROR, then the rest of server data is the exception info
if status != RESPONSE_STATUS_OK {
exceptions, err := rw.ReadErrorResponse(dbc.conx)
if err != nil {
return oerror.NewTrace(err)
}
return fmt.Errorf("Server Error(s): %v", exceptions)
}
// for the REQUEST_DB_OPEN case, another int is returned which is the new sessionId
sessionId, err := rw.ReadInt(dbc.conx)
if err != nil {
return oerror.NewTrace(err)
}
dbc.sessionId = sessionId
// next is the token, which may be null
tokenBytes, err := rw.ReadBytes(dbc.conx)
if err != nil {
return oerror.NewTrace(err)
}
dbc.token = tokenBytes
// array of cluster info in this db // TODO: do we need to retain all this in memory?
numClusters, err := rw.ReadShort(dbc.conx)
if err != nil {
return oerror.NewTrace(err)
}
clusters := make([]OCluster, 0, numClusters)
for i := 0; i < int(numClusters); i++ {
clusterName, err := rw.ReadString(dbc.conx)
if err != nil {
return oerror.NewTrace(err)
}
clusterId, err := rw.ReadShort(dbc.conx)
if err != nil {
return oerror.NewTrace(err)
}
clusters = append(clusters, OCluster{Name: clusterName, Id: clusterId})
}
dbc.currDB.Clusters = clusters
// cluster-config - bytes - null unless running server in clustered config
// TODO: treating this as an opaque blob for now
clusterCfg, err := rw.ReadBytes(dbc.conx)
if err != nil {
return oerror.NewTrace(err)
}
dbc.currDB.ClustCfg = clusterCfg
// orientdb server release - throwing away for now // TODO: need this?
_, err = rw.ReadString(dbc.conx)
if err != nil {
return oerror.NewTrace(err)
}
//
/* ---[ load #0:0 - config record ]--- */
schemaRIDStr, err := loadConfigRecord(dbc)
if err != nil {
return oerror.NewTrace(err)
}
clusterID, clusterPos, err := parseRid(schemaRIDStr)
if err != nil {
return oerror.NewTrace(err)
}
//
/* ---[ load #0:1 - schema record ]--- */
err = loadSchema(dbc, oschema.ORID{ClusterID: clusterID, ClusterPos: clusterPos})
if err != nil {
return oerror.NewTrace(err)
}
return nil
}
//
// ConnectToServer logs into the OrientDB server with the appropriate
// admin privileges in order to execute server-level commands (as opposed
// to database-level commands). This must be called to establish a server
// session before any other server-level commands. The username and password
// required are for the server (admin) not any particular database.
//
func ConnectToServer(dbc *DBClient, adminUser, adminPassw string) error {
buf := dbc.buf
buf.Reset()
// first byte specifies request type
err := rw.WriteByte(buf, REQUEST_CONNECT)
if err != nil {
return err
}
// session-id - send a negative number to create a new server-side conx
err = rw.WriteInt(buf, RequestNewSession)
if err != nil {
return err
}
err = rw.WriteStrings(buf, DriverName, DriverVersion)
if err != nil {
return err
}
err = rw.WriteShort(buf, dbc.binaryProtocolVersion)
if err != nil {
return err
}
// dbclient id - send as null, but cannot be null if clustered config
// TODO: change to use dbc.clusteredConfig once that is added
err = rw.WriteNull(buf)
if err != nil {
return err
}
// serialization-impl
err = rw.WriteString(buf, dbc.serializationType)
if err != nil {
return err
}
// token-session // TODO: hardcoded as false for now -> change later based on ClientOptions settings
err = rw.WriteBool(buf, false)
if err != nil {
return err
}
// admin username, password
err = rw.WriteStrings(buf, adminUser, adminPassw)
if err != nil {
return err
}
// send to OrientDB server
_, err = dbc.conx.Write(buf.Bytes())
if err != nil {
return err
}
/* ---[ Read Server Response ]--- */
// first byte indicates success/error
status, err := rw.ReadByte(dbc.conx)
if err != nil {
return err
}
// the first int returned is the session id sent - which was the `RequestNewSession` sentinel
sessionValSent, err := rw.ReadInt(dbc.conx)
if err != nil {
return err
}
if sessionValSent != RequestNewSession {
return errors.New("Unexpected Error: Server did not return expected session-request-val that was sent")
}
// if status returned was ERROR, then the rest of server data is the exception info
if status != RESPONSE_STATUS_OK {
exceptions, err := rw.ReadErrorResponse(dbc.conx)
if err != nil {
return err
}
return fmt.Errorf("Server Error(s): %v", exceptions)
}
// for the REQUEST_CONNECT case, another int is returned which is the new sessionId
sessionId, err := rw.ReadInt(dbc.conx)
if err != nil {
return err
}
// TODO: this assumes you can only have one sessionId - but perhaps can have a server sessionid
// and one or more database sessions open at the same time ?????
dbc.sessionId = sessionId
tokenBytes, err := rw.ReadBytes(dbc.conx)
if err != nil {
return err
}
dbc.token = tokenBytes
return nil
}