meta_search.h File Reference

A set of routines to perform a metadata-based search of an iRODS server. It uses the iCAT functionality. More...

#include "jansson.h"
#include "irods_util_library.h"
#include "linked_list.h"
#include "typedefs.h"
#include "query.h"

Include dependency graph for meta_search.h:

Go to the source code of this file.

Data Structures
struct	IRodsSearch
	A set of SearchTerms to use when running a search. More...
struct	SearchTerm
	A datatype for storing the values needed for an iRODS search. More...
struct	SearchTermNode
	A datatype for storing a SearchTerm on a LinkedList. More...

Functions
QueryResults *	DoMetaSearch (const IRodsSearch *const search_p, struct IRodsConnection *connection_p, int *select_column_ids_p, const int num_select_columns, const bool upper_case_flag, char *zone_s)
	Perform a meta-based search. More...
QueryResults *	DoMetaSearchForAllDataAndCollections (const IRodsSearch *const search_p, struct IRodsConnection *connection_p, const bool upper_case_flag, char *zone_s)
	Perform a meta-based search for all matching Data Objects and Collections. More...

Detailed Description

A set of routines to perform a metadata-based search of an iRODS server. It uses the iCAT functionality.

Created on: 2 Feb 2015 Author: tyrrells

Function Documentation

DoMetaSearch()

QueryResults* DoMetaSearch	(	const IRodsSearch *const	search_p,
		struct IRodsConnection *	connection_p,
		int *	select_column_ids_p,
		const int	num_select_columns,
		const bool	upper_case_flag,
		char *	zone_s
	)

Perform a meta-based search.

Parameters

search_p	The IRodsSearch to perform.
connection_p	The connection to the iRODS server to perform the search on.
select_column_ids_p	An array of the column ids to use for the select clause.
num_select_columns	The number of ids pointed to by select_column_ids_p.
upper_case_flag	whether all values should be transformed into upper case values.
zone_s	Add an extra clause where all matches must be in this zone. If this is NULL it can be ignored.

Returns

The QueryResults from the search.

DoMetaSearchForAllDataAndCollections()

QueryResults* DoMetaSearchForAllDataAndCollections	(	const IRodsSearch *const	search_p,
		struct IRodsConnection *	connection_p,
		const bool	upper_case_flag,
		char *	zone_s
	)

Perform a meta-based search for all matching Data Objects and Collections.

Parameters

search_p	The IRodsSearch to perform.
connection_p	The connection to the iRODS server to perform the search on.
upper_case_flag	whether all values should be transformed into upper case values.
zone_s	Add an extra clause where all matches must be in this zone. If this is NULL it can be ignored.

Returns

The QueryResults from the search.