WELD Client/Database Communication Protocol

Interface Syntax

• Put:

  Client:

  PUT
  <DB Identifier String>
  <ClassName>
  <ClassSpecificArguements * #ClassSpecificArguements> (each on its own line)
  

  Server:

  <XXX> (Three digit status code)
  <UniqueObjectInteger (=0 if status failed)>

• Modify:

  Client:

  MODIFY
  <DB Identifier String>
  <ClassName>
  <UniqueObjectInteger>
  <ClassSpecificArguements * #ClassSpecificArguements> (each on its own line)

  Server:

  <XXX> (Three digit status code)
  

• Get by String: (Only Cells?)

  Client:

  GETSTR
  <DB Identifier String>
  <ClassName>
  <Location Identifier String>

  Server:

  <XXX> (Three digit status code)
  <ClassName>
  <ClassSpecificArguements * #ClassSpecificArguements> (each on its own line)
  <UniqueObjectInteger>
  <Int String # of Content Objects >
  <Int String # of Container Objects >

• Get by Id:

  Client:

  GETID
  <DB Identifier String>
  <ClassName>
  <IDString> (Integer String)

  Server:

  <XXX> (Three digit status code)
  <ClassName>
  <ClassSpecificArguements * #ClassSpecificArguements> (each on its own line)
  <UniqueObjectInteger>
  <Int String # of Content Objects >
  <Int String # of Container Objects >

• Get by Attachment:

  Client:

  GETATT
  <DB Identifier String>
  <ClassName>
  <UniqueObjectInteger>
  <CONTAINER || CONTENTS>
  <Int String of Attach # in list>

  Server:

  <XXX> (Three digit status code)
  <ClassName>
  <ClassSpecificArguements * #ClassSpecificArguements> (each on its own line)
  <UniqueObjectInteger>
  <Int String # of Content Objects >
  <Int String # of Container Objects >

• Get Attachment Information:

  Client:

  GETATTINFO
  <DB Identifier String>
  <ClassName>
  <UniqueObjectInteger>
  <CONTAINER || CONTENTS>
  <Int String of Attach # in list>

  Server:

  <XXX> (Three digit status code)
  <ClassName>
  <UniqueObjectInteger>
  

• Delete by Id:

  Client:

  DELETE
  <DB Identifier String>
  <ClassName>
  <IDString> (Integer String)

  Server:

  <XXX> (Three digit status code)

  *Tentatively: All children are deleted? How handle this? Also, is it worth it to have a delete by string? (I think that that would be bad, if we can have two objects with the same contents except for objectID...)

• Connect Two Objects by Id: (A -> B, A contains B)

  Client:

  CONNECT
  <DB Identifier String>
  <ID For A> (Integer String)
  <ID For B> (Integer String)

  Server:

  <XXX> (Three digit status code)

• Connect Two Objects, parent by Id child by info: (A -> B, A contains B, B being created)

  Client:

  CONNECTNEW
  <DB Identifier String>
  <ID For A> (Integer String)
  <ClassName for B>
  <ClassSpecificArguements * #ClassSpecificArguements> (each on its own line)
  

  Server:

  <XXX> (Three digit status code)
  <UniqueObjectInteger (for B)>

• Disconnect Two Objects by Id: (A -> B, A contains B)

  Client:

  DISCONNECT
  <DB Identifier String>
  <ID For A> (Integer String)
  <ID For B> (Integer String)

  Server:

  <XXX> (Three digit status code)

• GetRootDir

  Client:

  GETROOTDIR
  <DB Identifier String>

  Server:

  <XXX> (Three digit status code)
  <ClassName>
  <ClassSpecificArguements * #ClassSpecificArguements> (each on its own line)
  <UniqueObjectInteger>
  <Int String # of Content Objects >
  <Int String of "0" >

• GetContext

  (returns first field of each content)

  Client:

  GETCONTEXT
  <DB Identifier String>
  <ClassName>
  <IDString> (Integer String)

  Server:

  <XXX> (Three digit status code)
  <ClassName>
  <NumContents>
  <ContentClassName> (each on its own line)
  <Each Contents' first identifier> (each on its own line)
  <Each Contents' UniqueObjectInteger> (each on its own line)

Versioning

• Get Version (by Id):

  Client:

  GETVERID
  <DB Identifier String>
  <ClassName>
  <IDString> (Integer String, ID of version object)
  <VersionsString> (form A.B, "R", or "L")

  Server:

  <XXX> (Three digit status code)
  <ClassName>
  <ClassSpecificArguements * #ClassSpecificArguements> (each on its own line)
  <UniqueObjectInteger>
  <Int String # of Content Objects > (not valid/used)
  <Int String # of Container Objects > (not valid/used)

• Version Put:

  Client:

  PUTVER
  <DB Identifier String>
  <ClassName>
  <IDString> (Integer String)
  <Version Flag> ("P" for point (this single object) or "T" for tree rooted at this point. "R" appended to create a new release (incr A))
  <ClassSpecificArguements * #ClassSpecificArguements> (each on its own line)
  

  Server:

  <XXX> (Three digit status code)
  <UniqueObjectInteger (=0 if status failed)>
  (if Flag is P - returns id of VO, if Flag is T returns the id of the top of the copy tree (now under a VO)).

• Version GetContext

  (returns first field of each content)

  Client:

  VERGETCONTEXT
  <DB Identifier String>
  <ClassName>
  <IDString> (Integer String)

  Server:

  <XXX> (Three digit status code)
  <ClassName>
  <NumContents>
  <ContentClassName> (each on its own line)
  <Each Contents' version string> (each on its own line)
  <Each Contents' UniqueObjectInteger> (each on its own line)

• QUERY

  (only a simple start, much more needs to be done here...)

  Client:

  QUERY
  <DB Identifier String> (= "global" for global search)
  <ClassName>
  <Query Scope> ("G" for global, "C" for class, "D" for container/db)
  <Search Index Type ("F" for fieldname, "I" for integer)
  <Field Name/Index Number>
  <IDString> (search String)

  Server:

  <XXX> (Three digit status code)
  <NumContents>
  <Each Found Object's Class Type> (each on its own line)
  <Each Found Object's UniqueObjectInteger> (each on its own line)

• Generators:

  Generators are tracked by the client, so that the server can stay as stateless as possible (in terms of connections).

Details

• Multiple attachments between the same object are not allowed.

• The power of prevention is in the hands of the application developer. The database will allow you to make an object its own parent/child, as well as allow (potentially fatal) cycles (for now).

• Connections (attachments) must be unique - multiple connections are currently undefined.

Last modified: Wed Feb 12 10:43:46 PST