Interface for representing an entry in IObjectBindDefs or ArrayBindDefs.

Hierarchy

Properties

Properties

dir: number

The direction of the bind. One of the Execute Bind Direction Constants BIND_IN, BIND_INOUT, or BIND_OUT. The default is BIND_IN.

maxSize?: number

The maximum number of bytes that an OUT or INOUT bind variable of type STRING or UINT8ARRAY can use to get data. The default value is 200. The maximum limit depends on the database type. When binding INOUT, maxSize refers to the size of the returned value. The input value can be smaller or bigger. For IN binds, maxSize is ignored. When data is being returned from the database, maxSize must be at least the size of the longest value. If maxSize is too small, an error gets thrown.

type: string | number | IDbObjectClass

The JavaScript data type to be bound. One of the mle-js-oracledb JS Constants; when binding ADTs, a type descriptor or the fully-qualified name (FQN) of the type is also accepted. With IN or INOUT binds the type can be explicitly set with type or it will default to the type of the input data value. With OUT binds, the type defaults to STRING whenever type is not specified.