Releasing Collection Resources

When your DataBlade API module no longer needs a collection, you can release the resources that it uses with the following DataBlade API functions.

DataBlade API Function

Purpose

mi_collection_close( )

Closes the collection cursor and frees the collection descriptor.

mi_collection_free( )

Frees the collection structure

Closing a Collection

A collection descriptor contains a collection cursor. The scope of the collection descriptor and its associated collection cursor is from the time they are created, by mi_collection_open_with_options( ) or mi_collection_open( ), until one of the following events occurs:

• The mi_collection_close( ) function frees the collection descriptor, thereby closing and freeing the associated collection cursor.
• The current memory duration expires.
• The mi_close( ) function closes the connection.

To conserve resources, use the mi_collection_close( ) function to free the collection descriptor as soon as your DataBlade API module no longer needs it. This function also explicitly closes and frees the associated collection cursor. The mi_collection_close( ) function is the destructor function for the collection descriptor as well as for its associated cursor.

Freeing the Collection Structure

The collection structure holds the collection elements. The scope of this structure is from the time it is created, by mi_collection_create( ) or mi_collection_copy( ), until one of the following events occurs:

• The mi_collection_free( ) function frees the collection structure.
• The current memory duration expires.
• The mi_close( ) function closes the connection.

To conserve resources, use the mi_collection_free( ) function to free the collection structure once your DataBlade API module no longer needs it. The mi_collection_close( ) function is the destructor function for the collection structure.