IRodsSearch Struct Reference

A set of SearchTerms to use when running a search. More...

#include <meta_search.h>

Collaboration diagram for IRodsSearch:

Public Member Functions
IRodsSearch *	AllocateIRodsSearch (void)
	Allocate an IRodsSearch. More...
void	FreeIRodsSearch (IRodsSearch *search_p)
	Free an IRodsSearch. More...
void	ClearIRodsSearch (IRodsSearch *search_p)
	Clear an IRodsSearch. More...
QueryResults *	DoIRodsSearch (IRodsSearch *search_p, struct IRodsConnection *connection_p)
	Perform an iRODS search. More...
bool	AddMetadataDataAttributeSearchTerm (IRodsSearch *search_p, const char *clause_s, const char *key_s, const char *op_s, const char *value_s)
	Create and add a SearchTerm to an IRodsSearch. More...
bool	AddIRodsSearchTerm (IRodsSearch *search_p, const char *clause_s, const char *key_s, const int key_id, const char *op_s, const char *value_s, const int value_id)
	Add a search term to an IRodsSearch. More...
int32	DetermineSearchTerms (LinkedList *terms_p, const json_t *json_p)
	Parse a JSON fragment and add SearchTermNodes to a LinkedList. More...

Data Fields
LinkedList *	is_search_terms_p
	A LinkedList of SearchTermNodes. More...

Detailed Description

A set of SearchTerms to use when running a search.

Member Function Documentation

AllocateIRodsSearch()

IRodsSearch * AllocateIRodsSearch

(

void

)

Allocate an IRodsSearch.

Returns

A newly-allocated IRodsSearch or NULL upon error.

FreeIRodsSearch()

void FreeIRodsSearch

(

IRodsSearch *

search_p

)

Free an IRodsSearch.

Parameters

search_p

The IRodsSearch to free.

ClearIRodsSearch()

void ClearIRodsSearch

(

IRodsSearch *

search_p

)

Clear an IRodsSearch.

Parameters

search_p

The IRodsSearch to clear.

DoIRodsSearch()

QueryResults * DoIRodsSearch	(	IRodsSearch *	search_p,
		struct IRodsConnection *	connection_p
	)

Perform an iRODS search.

Parameters

search_p	The IRodsSearch to perform.
connection_p	The connection to the iRODS server to perform the search on.

Returns

The QueryResults from the search.

AddMetadataDataAttributeSearchTerm()

bool AddMetadataDataAttributeSearchTerm	(	IRodsSearch *	search_p,
		const char *	clause_s,
		const char *	key_s,
		const char *	op_s,
		const char *	value_s
	)

Create and add a SearchTerm to an IRodsSearch.

This adds a search term in the form of a key op value triplet as described in AddIRodsSearchTerm

Parameters

search_p	The IRodsSearch to add the SearchTerm to.
clause_s	The search term's clause.
key_s	The search term's key.
op_s	The search term's operation such as "=", "<", etc.
value_s	The search term's value.

Returns

true if the search term was added successfully, false otherwise.

See also

AddIRodsSearchTerm

AddIRodsSearchTerm()

bool AddIRodsSearchTerm	(	IRodsSearch *	search_p,
		const char *	clause_s,
		const char *	key_s,
		const int	key_id,
		const char *	op_s,
		const char *	value_s,
		const int	value_id
	)

Add a search term to an IRodsSearch.

This adds a search term in the form of a key op value triplet. For example key could be "foo", value = "bar" and op = "="

Parameters

search_p	The IRodsSearch to add the term to.
clause_s	The search term's clause.
key_s	The search term's key.
key_id	The id of the key's column.
op_s	The search term's operation such as "=", "<", etc.
value_s	The search term's value.
value_id	The id of the value's column.

Returns

true if the search term was added successfully, false otherwise.

DetermineSearchTerms()

int32 DetermineSearchTerms	(	LinkedList *	terms_p,
		const json_t *	json_p
	)

Parse a JSON fragment and add SearchTermNodes to a LinkedList.

Parameters

terms_p	The LinkedList where the SearchTermNodes will get added.
json_p	The JSON fragment to parse. The JSON is of the form:

{
    "key": "key_value",
    "key_id": key_id,
    "value": "value_value",
    "value_id": value_id,
    "clause": "clause_value"
}

Returns

The number of search terms added.

Field Documentation

is_search_terms_p

LinkedList* is_search_terms_p

A LinkedList of SearchTermNodes.

See also

SearchTermNode

---

The documentation for this struct was generated from the following file:

• meta_search.h