Progress will discontinue Telerik Platform on May 10th, 2018. Learn more

Stored Procedures Fields and Values Reference

Stored Procedures Fields and Values Reference

You need to understand the specific object fields and their values when working with stored procedures in Telerik Platform.

Use the information in this article to complement the instructions in the rest of the articles about stored procedures. It includes these references:

Raw Stored Procedure Object Fields

The next table represents the stored procedure metadata object as retrieved from the database. Note that this object differs from the mapped stored procedure object that you can retrieve from Telerik Platform using Reading Stored Procedure Mappings operations.

Field Type Description
Catalog String The catalog name.
Schema String The schema name.
Name String The procedure name.
Type Number The procedure type as per the Java SE 8 Constant Field Values. For a quick reference, see Stored Procedure Type Field Values.
FullName String The procedure name that uniquely identifies the procedure.

Raw Stored Procedure Parameter Object Fields

Mapping parameters is currently not supported when connecting to Salesforce. Requesting parameters metadata for Salesforce reports always returns an empty collection.

The next table represents the raw stored procedure parameter metadata object as retrieved from the database. Note that this object differs from the mapped stored procedure parameter object that you can retrieve from Telerik Platform as part of the Reading Stored Procedure Mappings operations.

Field Name Type Description
Name String The parameter name in the database.
Type Number The parameter type: IN, INOUT, OUT, etc. This is a `java.sql.DatabaseMetaData` value as per Java SE 8 Constant Field Values. For a quick reference see Stored Procedure Parameter Type Field Values.
ByteLength Number Length in bytes of data.
Position Number The parameter's position relative to other parameters as defined in the database.
TypeName String SQL type name. For a UDT type the type name is fully qualified.
EverliveType String The Telerik Platform type to which the original parameter type is mapped in textual form. See Supported Field Types When Managing Content Types Through the Administration API for the possible values. Example: "Text".
DataType Number The parameter value type. This is a SQL type from java.sql.Types (See the java.sql.Types table).

Mapped Stored Procedure Object Fields

The next table represents the stored procedure object as stored in the Telerik Platform cloud. Note that this object differs from the raw stored procedure object that you can retrieve directly from the database using Reading Stored Procedure Metadata.

Name Type Description
Name String The declared name of the function specified at the mapping time.
DataLinkId GUID The ID of the Data Connector configured in your Telerik Platform app.
ProcedureCatalog String The name of the catalog where the procedure is defined.
ProcedureName String The name of the procedure as defined in the database.
ProcedureSchema String The name of the stored procedure's schema context.
Mapping Array An array of objects each of which contains a stored procedure parameter. The array is empty if the stored procedure lacks parameters. See Mapped Stored Procedure Parameter Object Fields for field descriptions. Always empty for Salesforce.

The JSON representation of a mapped stored procedure in a Telerik Platform app looks like this:

{
    "Name": "generateRandomString",
    "CreatedAt": "2015-06-23T11:04:23.806Z",
    "ModifiedAt": "2015-06-23T11:40:18.415Z",
    "DataLinkId": "d8e9fbf0-1996-11e5-ac3d-4796c3b1ba9d",
    "ProcedureCatalog": "telerik",
    "ProcedureSchema": "dbo",
    "ProcedureName": "GenerateRandomString",
    "Mapping": [
        {
            "Name": "@sLength",
            "Type": 1,
            "Position": 1,
            "DataType": -6,
            "DefaultValue": null,
            "Validators": {
                "Required": true
            },
            "EverliveType": "Number",
            "ServerName": "@sLength"
        },
        {
            "Name": "@randomString",
            "Type": 2,
            "Position": 2,
            "DataType": 12,
            "DefaultValue": null,
            "Validators": {
                "Required": true
            },
            "EverliveType": "Text",
            "ServerName": "@randomString"
        }
    ],
    "ModifiedBy": "00000000-0000-0000-0000-000000000000",
    "Id": "9b2111e0-1997-11e5-aa5e-854c716bee06"
}

Mapped Stored Procedure Parameter Object Fields

Mapping parameters is currently not supported when connecting to Salesforce. Respectively, this object will always be empty.

The next table represents the mapped stored procedure parameter metadata object as stored in the Telerik Platform cloud. Note that this object differs from the raw stored procedure parameter object that you can retrieve directly from the database using Reading Stored Procedure Parameters Metadata.

Name Type Description
DefaultValue Object The default value for the parameter to be used when invoking the endpoint. If not set and no parameter is supplied when the endpoint is called, the default value from the definition of the stored procedure is used.
Name String The declared name of the parameter as defined when mapping the function.
Type Number The parameter type: IN, INOUT, OUT, etc. This is a `java.sql.DatabaseMetaData` value as per Java SE 8 Constant Field Values. For a quick reference see Stored Procedure Parameter Type Field Values.
Position Number The parameter's position relative to other parameters as defined in the database.
DataType Text The parameter value type. This is a SQL type from java.sql.Types (See the java.sql.Types table).
Validators Object Object that holds a definition for the possible validation rules for each parameter. See the Stored Procedure Parameter Validators Field Values reference table.
EverliveType String The Telerik Platform type to which the original parameter type is mapped in textual form. See Supported Field Types When Managing Content Types Through the Administration API for the possible values. Example: "Text".
EverliveDataType Number The numerical representation of the EverliveType to which the original parameter type is mapped. See Supported Field Types When Managing Content Types Through the Administration API for the possible values. Example: 1.
ServerName String The parameter name as in the procedure definition in the database. Must correspond to the Name field from the Raw Stored Procedure Parameter Object Fields.

The DataType, Type, EverliveType and Position fields are obtained from the data store when reading the stored procedure parameters metadata. Reuse them when mapping a stored procedure using the RESTful API. Instead of EverliveType you can supply the EverliveDataType value when mapping an endpoint to a stored procedure.

Stored Procedure Type Field Values

The next table summarizes the information in Java SE 8 Constant Field Values.

Value Constant Field Name Description
0 procedureResultUnknown Cannot determine if a result will be returned.
1 procedureNoResult Does not return a result.
2 procedureReturnsResult Returns a result.

Stored Procedure Parameter Type Field Values

Not applicable to Salesforce reports.

The next table summarizes the information in Java SE 8 Constant Field Values. They are applicable to the Type field when used in the mapping of a stored procedure parameter.

Value Constant Field Name Description
0 procedureColumnUnknown Indicates that the parameter type is unknown.
1 procedureColumnIn Indicates that the parameter type is IN.
2 procedureColumnInOut Indicates that the parameter type is INOUT.
3 procedureColumnResult Indicates that the parameter stores results.
4 procedureColumnOut Indicates that the parameter type is OUT.
5 procedureColumnReturn Indicates that the parameter stores return values.

Stored Procedure Parameter Validators Field Values

Not applicable to Salesforce reports.

The next table displays the possible validation rules you can apply to each parameter when creating an endpoint from a stored procedure with parameters. The validation rules for the parameters will be applied by the web service at the time of invoking it, prior to calling the stored procedure in the database server.

Field Name Type Default Value Description
Required Boolean False Indicates whether the parameter is required.

Example:

"Validators": {
    "Required": true
    }         

See Also

Start a free trial Request a demo
Contact us: +1-888-365-2779
sales@telerik.com
Copyright © 2016-2017, Progress Software Corporation and/or its subsidiaries or affiliates. All rights reserved.