oci_new_collection

(PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0)

oci_new_collection — Allocates new collection object

Beschreibung

oci_new_collection(resource $connection, string $type_name, ?string $schema = null): OCICollection|false

Allocates a new collection object.

Parameter-Liste

connection: An Oracle connection identifier, returned by oci_connect() or oci_pconnect().
type_name: Should be a valid named type (uppercase).
schema: Should point to the scheme, where the named type was created. The name of the current user is used when null is passed.

Rückgabewerte

Returns a new OCICollection object or false on error.

Changelog

Version	Beschreibung
8.0.0, PECL OCI8 3.0.0	`schema` is now nullable.

Anmerkungen

Hinweis:
The OCICollection class was called OCI-Collection prior to PHP 8 and OCI8 3.0.0.

add a note

User Contributed Notes 1 note

down

VLroyrenn ¶

6 years ago


This is a woefully underdocumented feature (at least here), but being able to bind collections to prepared statements instead of rolling your own SQL arrays is a massive improvement in terms of safety and conveinience, and a feature I think more DBMS should have in their API.

You can basically send collections of the types listed by the following query :

SELECT * FROM SYS.ALL_TYPES WHERE TYPECODE = 'COLLECTION' AND TYPE_NAME LIKE 'ODCI%'

Those are all collections that can contain any number of the SQL type indicated in their name. 

<?php
$my_array = ["foo", "bar", "baz"];

$my_collection = oci_new_collection($conn, 'ODCIVARCHAR2LIST', 'SYS');

foreach($my_array as $elem) {
    $cell_collection->append($elem);
}

oci_bind_by_name($statement, ":collection", $my_collection, -1, SQLT_NTY);
?>

The collection ressource can be appended with numbers, strings or dates (which need to be passed as strings in the "DD-MON-YY" format, such as "27-MAR-18", apparently) depending on the types supported by the collection you're using, and none of these appear to support timestamps or any of the more complex data types.

Code for the OCI collection type, for reference :

http://git.php.net/?p=php-src.git;a=blob;f=ext/oci8/oci8_collection.c;hb=refs/heads/master#l429

add a note