interface Query

this is interface for UAKG Query Query is SQL text with set of parameters: prepare parameters and execute parameters.

Public Fields

readonly attribute QueryManager query_mgr

readonly attribute string queryText

Public Methods

CosQuery::QueryStatus get_status()

return status of query: ie: complete when query is executed, otherwise incomplete

void prepare_query(in RecordDescription paramsDescription) raises(CosQuery::QueryProcessingError)

prepare query for executing.

void prepare(in RecordDescription paramsDescription) raises(CosQuery::QueryProcessingError)

synonim for prepare_query

void execute_rc(in OctSeq octSeq_) raises(CosQuery::QueryProcessingError)

execute query

void execute_rc_inout(inout OctSeq octSeq_) raises(CosQuery::QueryProcessingError)

execute query with inout parameters

void execute_records(in RC::RecordSeq records) raises(CosQuery::QueryProcessingError)

execute query

void execute_record(in CosQueryCollection::Record record_) raises(CosQuery::QueryProcessingError)

execute query

void execute_records_inout(inout RC::RecordSeq recordSeq_) raises(CosQuery::QueryProcessingError)

RecordDescription get_result_description() raises(CosQuery::QueryProcessingError, QueryNotPrepared)

RecordDescription get_parameters_description() raises(CosQuery::QueryProcessingError)

get description of records parameters

RC::RecordSeq get_all_parameters_records() raises(CosQuery::QueryProcessingError)

RC::RecordSeq get_parameters_records(in StringSeq neededFields) raises(CosQuery::QueryProcessingError, InvalidParameterName)

OctSeq get_all_parameters_rc() raises(CosQuery::QueryProcessingError)

OctSeq get_parameters_rc(in StringSeq fieldNames) raises(CosQuery::QueryProcessingError, InvalidParameterName)

unsigned long get_row_count() raises(CosQuery::QueryProcessingError)

OctSeq fetch_rc(in unsigned long numberOfRecords, out boolean more) raises(CosQuery::QueryProcessingError)

fetch query result in records.

OctSeq get_result_rc(in unsigned long numberOfRecords) raises(CosQuery::QueryProcessingError)

synonim for fetch_rc

RC::RecordSeq fetch_records(in unsigned long numberOfRecords, out boolean more) raises(CosQuery::QueryProcessingError)

fetch query result in records.

RC::RecordSeq get_result_records(in unsigned long numberOfRecords) raises(CosQuery::QueryProcessingError)

synonim for fetch_records

unsigned long skip(in unsigned long numberOfRecords, out boolean more) raises(CosQuery::QueryProcessingError)

skip N records without retrieving.

CosQueryCollection::Blob create_blob() raises(CosQuery::QueryProcessingError)

request Blob for filling query parameters

CosQueryCollection::Clob create_clob() raises(CosQuery::QueryProcessingError)

request Clob for filling query parameters

CosQueryCollection::Wclob create_wclob() raises(CosQuery::QueryProcessingError)

request Wclob for filling query parameters

QueryError get_last_error()

void destroy()

destroy query, which not longer needed

Documentation

this is interface for UAKG Query Query is SQL text with set of parameters: prepare parameters and execute parameters. prepare parameters are descriptionas of appropriative execute parameters execute parameters are SQL host valiables. i. e. let we have query (SELECT * from T where x=:x and y=:y); than prepare query have type RecordDescription and consist from FieldDescription of :x and :y. execute query are values of :x and :y (or sequence of pair of values for multiple evaluated query).

readonly attribute QueryManager query_mgr

Returns:

owner of query

readonly attribute string queryText

Returns:

text of query.

CosQuery::QueryStatus get_status()

return status of query: ie: complete when query is executed, otherwise incomplete

void prepare_query(in RecordDescription paramsDescription) raises(CosQuery::QueryProcessingError)

prepare query for executing. if query have no parameters, paramsDescription must be empty sequence.

void prepare(in RecordDescription paramsDescription) raises(CosQuery::QueryProcessingError)

synonim for prepare_query

void execute_rc(in OctSeq octSeq_) raises(CosQuery::QueryProcessingError)

execute query

Parameters:

s - octSeq_ records of execute parameters, coded as RCSeq (note, that prepare parameters is record descriptio of execute record).

void execute_rc_inout(inout OctSeq octSeq_) raises(CosQuery::QueryProcessingError)

execute query with inout parameters

Parameters:

s - octSeq_ records of execute parameters, coded as RCSeq

void execute_records(in RC::RecordSeq records) raises(CosQuery::QueryProcessingError)

execute query

Parameters:

s - records -- query host parameters in RecordSeq (query will be evaluated records.length() times)

void execute_record(in CosQueryCollection::Record record_) raises(CosQuery::QueryProcessingError)

execute query

Parameters:

s - record_ -- query host parameters in one recod

void execute_records_inout(inout RC::RecordSeq recordSeq_) raises(CosQuery::QueryProcessingError)

RecordDescription get_result_description() raises(CosQuery::QueryProcessingError, QueryNotPrepared)

RecordDescription get_parameters_description() raises(CosQuery::QueryProcessingError)

get description of records parameters

Preconditions:

must be called after prepare

RC::RecordSeq get_all_parameters_records() raises(CosQuery::QueryProcessingError)

RC::RecordSeq get_parameters_records(in StringSeq neededFields) raises(CosQuery::QueryProcessingError, InvalidParameterName)

OctSeq get_all_parameters_rc() raises(CosQuery::QueryProcessingError)

OctSeq get_parameters_rc(in StringSeq fieldNames) raises(CosQuery::QueryProcessingError, InvalidParameterName)

unsigned long get_row_count() raises(CosQuery::QueryProcessingError)

Returns:

s number of fetched rows.

OctSeq fetch_rc(in unsigned long numberOfRecords, out boolean more) raises(CosQuery::QueryProcessingError)

fetch query result in records.

Parameters:

numberOfRecords - -- number of records to fetch. 0 means, that we want to fetch all records.
more - -- true, if status is incomplete (i.e. we can query more results), otherwise false.

Returns:

s fetched rows packed in RC coding to octet sequence.

OctSeq get_result_rc(in unsigned long numberOfRecords) raises(CosQuery::QueryProcessingError)

synonim for fetch_rc

RC::RecordSeq fetch_records(in unsigned long numberOfRecords, out boolean more) raises(CosQuery::QueryProcessingError)

fetch query result in records.

Parameters:

numberOfRecords - -- number of records to fetch. 0 means, that we want to fetch all records.
more - -- true, if status is incomplete (i.e. we can query more results), otherwise false.

Returns:

s fetched records.

RC::RecordSeq get_result_records(in unsigned long numberOfRecords) raises(CosQuery::QueryProcessingError)

synonim for fetch_records

unsigned long skip(in unsigned long numberOfRecords, out boolean more) raises(CosQuery::QueryProcessingError)

skip N records without retrieving.

Returns:

s actual number of skipped records.

CosQueryCollection::Blob create_blob() raises(CosQuery::QueryProcessingError)

request Blob for filling query parameters

Returns:

s empty Blob for writing only.

CosQueryCollection::Clob create_clob() raises(CosQuery::QueryProcessingError)

request Clob for filling query parameters

Returns:

s empty Clob for writing only.

CosQueryCollection::Wclob create_wclob() raises(CosQuery::QueryProcessingError)

request Wclob for filling query parameters

Returns:

s empty Wclob for writing only.

QueryError get_last_error()

Returns:

last error. if Query is ok, code in error is 0.

void destroy()

destroy query, which not longer needed

This class has no child classes.

Alphabetic index