MLE Foreign Function Interface (FFI): API for calling PL/SQL functionality directly(mle-js-plsql-ffi)
    Preparing search index...

    Type Alias ArgInfo

    Argument description.

    type ArgInfo = {
        dir?: number;
        maxArraySize?: number;
        maxSize?: number;
        type?: number | string;
        val?: any;
    }
    Index

    Properties

    dir? maxArraySize? maxSize? type? val?

    Properties

    dir?: number

    The argument direction. In almost all cases this is not necessary and the direction chosen by the FFI should be used. Accepted values:

    • oracledb.BIND_IN
    • oracledb.BIND_OUT
    • oracledb.BIND_INOUT.
    maxArraySize?: number

    The number of array elements to be allocated for a PL/SQL INDEX BY associative array.

    Needed for all OUT associative array arguments. INDEX BY VARCHAR2 associative arrays are not supported.

    maxSize?: number

    The maximum number of bytes an argument with OUT values can take up. Default: 200.

    type?: number | string

    If the type chosen by FFI needs to be changed this property can be used. This property needs to be set to either an oracledb type constant or to the name of the database type in case of a user defined named type (e.g. record or object). This can be useful to ensure no precision loss when e.g. retrieving a number (by specifying the oracledb.ORACLE_NUMBER override). It can also be useful to specify the correct overload if the FFI cannot determine the correct subprogram to use in a package.

    Named types are case sensitive.

    val?: any

    The value of the argument.

    Settings

    Member Visibility

    On This Page

    Properties