query.h File Reference

#include <jansson.h>
#include "irods_util_library.h"
#include "linked_list.h"

Include dependency graph for query.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	QueryResult
	A datatype for accessing a single result of a search on an iRODS server. More...
struct	QueryResults
	A datatype for holding an array of the results of a search on an iRODS server. More...

Functions
char *	BuildQueryString (const char **args_ss)
	Build a new query string to use to execute a query. More...
void	FreeBuiltQueryString (char *query_s)
	Free a previously generated query string. More...
QueryResults *	GetAllMetadataDataAttributeNames (struct IRodsConnection *connection_p)
	Get all of the data attribute names within the iCAT system of an iRODS server. More...
QueryResults *	GetAllMetadataDataAttributeValues (struct IRodsConnection *connection_p, const char *const name_s)
	Get all of the data attribute values for the given name within the iCAT system of an iRODS server. More...
QueryResults *	GetAllMetadataCollectionAttributeNames (struct IRodsConnection *connection_p)
	Get all of the collection attribute names within the iCAT system of an iRODS server. More...
QueryResults *	GetAllMetadataUserAttributeNames (struct IRodsConnection *connection_p)
	Get all of the user attribute names within the iCAT system of an iRODS server. More...
QueryResults *	GetAllMetadataAttributeValues (struct IRodsConnection *connection_p, const int key_id, const char *const key_s, const int value_id)
	Get all of the data attribute names within the iCAT system of an iRODS server for give column id. More...

Function Documentation

GetAllMetadataDataAttributeNames()

QueryResults* GetAllMetadataDataAttributeNames

(

struct IRodsConnection *

connection_p

)

Get all of the data attribute names within the iCAT system of an iRODS server.

Parameters

connection_p

The connection to an iRODS server.

Returns

A newly-allocated QueryResults listing all of the data attribute names or NULL upon error.

See also

GetAllAttributeNames

GetAllMetadataDataAttributeValues()

QueryResults* GetAllMetadataDataAttributeValues	(	struct IRodsConnection *	connection_p,
		const char *const	name_s
	)

Get all of the data attribute values for the given name within the iCAT system of an iRODS server.

Parameters

connection_p	The connection to an iRODS server.
name_s	The metadata attribute name to get all of the values for.

Returns

A newly-allocated QueryResults listing all of the data attribute values or NULL upon error.

GetAllMetadataCollectionAttributeNames()

QueryResults* GetAllMetadataCollectionAttributeNames

(

struct IRodsConnection *

connection_p

)

Get all of the collection attribute names within the iCAT system of an iRODS server.

Parameters

connection_p

The connection to an iRODS server.

Returns

A newly-allocated QueryResults listing all of the collection attribute names or NULL upon error.

GetAllMetadataUserAttributeNames()

QueryResults* GetAllMetadataUserAttributeNames

(

struct IRodsConnection *

connection_p

)

Get all of the user attribute names within the iCAT system of an iRODS server.

Parameters

connection_p

The connection to an iRODS server.

Returns

A newly-allocated QueryResults listing all of the user attribute names or NULL upon error.

GetAllMetadataAttributeValues()

QueryResults* GetAllMetadataAttributeValues	(	struct IRodsConnection *	connection_p,
		const int	key_id,
		const char *const	key_s,
		const int	value_id
	)

Get all of the data attribute names within the iCAT system of an iRODS server for give column id.

Parameters

connection_p	The connection to an iRODS server.
key_id	The id of the column to use as the key for.
key_s	The name of the key column.
value_id	The id of the column to get values for.

Returns

A newly-allocated QueryResults listing all of the data attribute names or NULL upon error.

See also

GetAllMetadataDataAttributeValues