12 December 2008

Calling Oracle stored functions from ADO.NET

Die-hard Microsofties may be flabbergasted, but there are people out there using Oracle as a database in stead of SQLServer and - oh horror - are even daft enough to try to retrieve data from it using ADO.NET. But while Microsoft cranks out code samples for using SQLServer by the the truckload, those that are living in a hybrid environment may have a hard time finding actual working data access sample code. Like calling a stored function in Oracle and retrieving the value. Suppose whe have the following trivial stored function, created by my collegue Louis Ywema for unit testing purposes. It takes a numerical value and a string value and concatenates them with a hyphen between. Not quite the functionality you've been waiting for all your life but it proves the point
create function get_test  (p_parameter1 in number
                   ,p_parameter2 in varchar2)
return varchar2
   l_parameter1 number;
   l_parameter2 varchar2(1024);
   l_parameter1 := p_parameter1;
   l_parameter2 := p_parameter2;
   return to_char(l_parameter1)||' - '||l_parameter2;
   when others then
end get_test
You run this code in a database user that has CREATE PROCEDURE privileges Next, you define an Oracle connection in your connectionStrings section of your config file:
  <add name="MYCONNECTION" 
    connectionString="Password=TEST;User ID=TEST;Data Source=JOOST;"
    providerName="System.Data.OracleClient" />
I use a database JOOST with username TEST and password TEST Using raw ADO.NET code you can run the stored function like this
[Test(Description = "Stored function - Raw ADO.NET")]
public void TestStoredFunctionRaw()
  var myConnection = 
  using (var connection = 
      new OracleConnection(myConnection.ConnectionString))
     using(var command = connection.CreateCommand() )
       var p1 = new OracleParameter("p_parameter1", OracleType.Number);
       p1.Value = 1;

       var p2 = new OracleParameter("p_parameter2", OracleType.VarChar);
       p2.Value = "Hello";

       var retVal = new OracleParameter("returnvalue", OracleType.VarChar);
       retVal.Size = 1024;
       retVal.Direction = ParameterDirection.ReturnValue;

       command.CommandText = "get_test";
       command.CommandType = CommandType.StoredProcedure;

       Assert.IsTrue(((string)retVal.Value) == "1 - Hello");
I would not recommend this to anyone but it proves the point. For real life situations, use the Enterprise Library and write your code like this
[Test(Description = "Stored function -  EL")]
public void TestStoredFunctionEntLib()
    Database Db = DatabaseFactory.CreateDatabase("MYCONNECTION");
    using (var cmd = Db.GetSqlStringCommand("get_test" ) )
      Db.AddInParameter(cmd, "p_parameter1", DbType.VarNumeric, 1);
      Db.AddInParameter(cmd, "p_parameter2", DbType.String, "Hello");
      Db.AddParameter(cmd, "returnvalue", DbType.String,1024, 
        false, 0, 0, null, DataRowVersion.Default, null);

      cmd.CommandType = CommandType.StoredProcedure;
      Assert.IsTrue(((string) cmd.Parameters[2].Value) == "1 - Hello");
Notice the "returnvalue" parameter - it has a ParameterDirection.ReturnValue and more importantly - it has a size. This is important: the default size of a parameter is 0, and if Oracle tries to write back te parameter value into the parameter you will get an error indicating so. In this example I use 1024, but you can set this to any size you need. In my production code I set it to 32K (32768) but I am not sure of the absolute maximum value. The crazy thing about this is, of course, there are situations where you cannot know the size of the return value. Your only option is to set is as high pas possible and hope for the best ;-) Complete test project downloadable here. This example still uses the May 2007 EntLib 3.1, by the way.


abhi said...

I have tried to use your code, but it throws an error. I am using the ODP.NET library.

The error I received was
getLocationId - ORA-06550: line 1, column 7:
PLS-00221: 'GETLOCATIONID' is not a procedure or is undefined
ORA-06550: line 1, column 7:
PL/SQL: Statement ignored

getLocationId is a function in my OracleDatabase and not a stored procedure.

The error I encountered forces me to change my code. I am now using an OracleReader and using the function in a query.

Loc#alJoost said...

@abhi: I am not familiar with ODP.NET, we are using either the built-in Oracle client (like I show in the example) or DevArt stuff.