OpenDbCommand: Operation

The OpenDbCommand operation opens the SQL object and returns the context for working with it.

Comments

To execute the operation, in the tObject parameter specify the repository SQL object moniker, and in the tArg parameter specify parameters of it opening. SQL object is one of the following types of repository objects:

The object moniker can be obtained on executing the GetObjects operation. The tArg field may contain opening mode (view or edit), values of the parameters to be sent to request, and the pattern for extracting metadata. The pattern specifies the information to be retrieved on executing the operation. The operation results in the opened SQL object instance moniker, and also the metadata obtained according to the pattern specified in the tArg.metaGet field. Use the GetDbCommand and SetDbCommand operations to further work with the opened object. To close the opened SQL object instance, use the CloseDbCommand operation.

Example

The example of opening SQL object for edit. The request contains the repository SQL object moniker. The response contains the opened SQL object instance moniker.

SOAP request:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

</tOb>

<args>

</args>

</tArg>

</OpenDbCommand>

</s:Body>

</s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Body>

</id>

</OpenDbCommandResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "OpenDbCommand" : 
  {
   "tOb" : 
    {
     "id" : "S2!M!9051"
    },
   "tArg" : 
    {
     "args" : 
      {
       "openForEdit" : "true"
      }
    }
  }
}

JSON response:

{
 "OpenDbCommandResult" : 
  {
   "id" : 
    {
     "id" : "S2!M!S!M1"
    }
  }
}

The OpenDbCommand function specified below opens SQL object of repository for edit. The repository connection moniker and SQL object identifier are sent as input parameters. The example uses the FindObjectById function, which code is given in the Getting Object Description by Its Identifier example. The result of the operation is the result of the function.

    public static OpenDbCommandResult OpenSQLObject(MbId mb, string id)
    {
        var somClient = new SomPortTypeClient(); //Proxy object for operation execution
        //Operation execution parameters
        var tOpen = new OpenDbCommand()
        {
            tArg = new OpenDbCommandArg()
            {
                args = new DbCommandOpenArgs() 
                {
                    openForEdit = true
                }
            },
            tOb = new OdId() { id = mb.id + "!" + FindObjectById(mb, id).k }
        };
        //Open dictionary
        var tResult = somClient.OpenDbCommand(tOpen);
        return tResult;
    }

OpenDbCommand

Syntax