irods  4.2.8
About: iRODS (the integrated Rule Oriented Data System) is a distributed data-management system for creating data grids, digital libraries, persistent archives, and real-time data systems.
  Fossies Dox: irods-4.2.8.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

Collaboration diagram for Client Metadata Operations:

Functions

int rcGenQuery (rcComm_t *conn, genQueryInp_t *genQueryInp, genQueryOut_t **genQueryOut)
 
int rcModAccessControl (rcComm_t *conn, modAccessControlInp_t *modAccessControlInp)
 
int rcModAVUMetadata (rcComm_t *conn, modAVUMetadataInp_t *modAVUMetadataInp)
 
int rcSimpleQuery (rcComm_t *conn, simpleQueryInp_t *simpleQueryInp, simpleQueryOut_t **simpleQueryOut)
 
int rcSpecificQuery (rcComm_t *conn, specificQueryInp_t *specificQueryInp, genQueryOut_t **genQueryOut)
 

Detailed Description

Function Documentation

◆ rcGenQuery()

rcGenQuery ( rcComm_t conn,
genQueryInp_t genQueryInp,
genQueryOut_t **  genQueryOut 
)
Description:\n Perform a general-query.
Primary User:\n client and server (internal queries to the ICAT as part of server ops)
Since
.5
Remarks
Perform a general-query:
This is used extensively from within server code and from clients.
Provides a simplified interface to query the iRODS database (ICAT).
Although the inputs and controls are a bit complicated, it allows
SQL-like queries but without the caller needing to know the structure
of the database (schema). SQL is generated for each call on the
server-side (in the ICAT code).
Note
none
Example Usage:\n
Parameters
[in]conn- A rcComm_t connection handle to the server
[in]genQueryInp- input general-query structure
[out]genQueryOut- output general-query structure
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 89 of file rcGenQuery.cpp.

References GEN_QUERY_AN, NULL, procApiRequest(), and irods.pypyodbc::status.

Referenced by checkIsMount(), chkObjConsistency(), chkObjExist(), irods::server_control_executor::get_resource_host_names(), getZoneType(), lsDataObjUtilLong(), lsSubfilesInBundle(), queryCollAcl(), queryCollInheritance(), queryDataObjAcl(), rclInitQueryHandle(), rsGenQuery(), and scanObjCol().

Here is the call graph for this function:

◆ rcModAccessControl()

rcModAccessControl ( rcComm_t conn,
modAccessControlInp_t modAccessControlInp 
)
Description:\n Modifies the access control metadata for iRODS entities.
Primary User:\n client and server
Since
.5
Remarks
This call performs various operations to modify the access control metadata for various types of objects. This is used by the ichmod command and processed by the chlModAccessControl routine.
Note
none
Example Usage:\n
Parameters
[in]conn- A rcComm_t connection handle to the server
[in]modAccessControlInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 39 of file rcModAccessControl.cpp.

References MOD_ACCESS_CONTROL_AN, NULL, procApiRequest(), and irods.pypyodbc::status.

Referenced by rsModAccessControl().

Here is the call graph for this function:

◆ rcModAVUMetadata()

rcModAVUMetadata ( rcComm_t conn,
modAVUMetadataInp_t modAVUMetadataInp 
)
Description:\n Modifies the Attribute-Value-Units of various iRODS entities.
Primary User:\n client and server
Since
.5
Remarks
This call performs various operations on the Attribute-Value-Units (AVU) triples type of metadata. The Units are optional, so these are frequently Attribute-Value pairs. ATUs are user-defined metadata items. The imeta command makes extensive use of this and the genQuery call.
Note
none
Example Usage:\n
Parameters
[in]conn- A rcComm_t connection handle to the server
[in]modAVUMetadataInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 41 of file rcModAVUMetadata.cpp.

References MOD_AVU_METADATA_AN, NULL, procApiRequest(), and irods.pypyodbc::status.

Referenced by rsModAVUMetadata().

Here is the call graph for this function:

◆ rcSimpleQuery()

rcSimpleQuery ( rcComm_t conn,
simpleQueryInp_t simpleQueryInp,
simpleQueryOut_t **  simpleQueryOut 
)
Description:\n Perform a simple (pre-defined) query, allowed for Admin only, used in iadmin
Primary User:\n client
Since
1.0
Remarks
none
Note
none
Example Usage:\n
Perform a simple (pre-defined) query:
See the SQL-Based_Queries on irods.org
and examples in iquest.c (function execAndShowSimpleQuery).
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]simpleQueryInp- input sql or alias (must match definition on server), and arguments
[out]simpleQueryOut- the same returned structure as general-query.
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 47 of file rcSimpleQuery.cpp.

References NULL, procApiRequest(), SIMPLE_QUERY_AN, and irods.pypyodbc::status.

Referenced by rsSimpleQuery().

Here is the call graph for this function:

◆ rcSpecificQuery()

rcSpecificQuery ( rcComm_t conn,
specificQueryInp_t specificQueryInp,
genQueryOut_t **  genQueryOut 
)
Description:\n Perform a specific (pre-defined) query.
Primary User:\n client
Since
2.5
Remarks
none
Note
none
Example Usage:\n
Perform a specific (pre-defined) query:
See the SQL-Based_Queries on irods.org
and examples in iquest.c (function execAndShowSpecificQuery).
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]specificQueryInp- input sql or alias (must match definition on server), and arguments
[out]genQueryOut- the same returned structure as general-query.
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 49 of file rcSpecificQuery.cpp.

References NULL, procApiRequest(), SPECIFIC_QUERY_AN, and irods.pypyodbc::status.

Referenced by queryCollAclSpecific(), and rsSpecificQuery().

Here is the call graph for this function: