query.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
** 
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
** 
**     http://www.apache.org/licenses/LICENSE-2.0
** 
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
 
#ifndef IRODS_QUERY_H
#define IRODS_QUERY_H
 
 
#include <jansson.h>
 
 
#include "irods_util_library.h"
#include "linked_list.h"
 
 
/* forward declaration */
struct IRodsConnection;
 
 
typedef struct QueryResult
{
  /*
   * Due to the columnNames array being in the same file as the
   * definition of columnName_t (rodsGenQueryNames.h) we get
   * multiple definition errors if we try to set qr_column_p to be
   * columnName_t, so we need to have it as void in the definition.
   * If rodsGenQueryNames.h gets refactored or if the struct that
   * columnName_t is a typedef of ceases to be anonymous, then we can
   * change this.
   */
  const void *qr_column_p;
  char **qr_values_pp;
  int qr_num_values;
} QueryResult;
 
 
typedef struct QueryResults
{
  int qr_num_results;
 
  QueryResult *qr_values_p;
} QueryResults;
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
 
IRODS_UTIL_API char *BuildQueryString (const char **args_ss);
 
 
IRODS_UTIL_API void FreeBuiltQueryString (char *query_s);
 
 
IRODS_UTIL_API void PrintQueryResults (FILE *out_f, const QueryResults * const result_p);
 
 
IRODS_UTIL_API void PrintQueryResult (FILE *out_f, const QueryResult * const result_p);
 
 
 
IRODS_UTIL_API void FreeQueryResults (QueryResults *result_p);
 
 
IRODS_UTIL_LOCAL const char *GetColumnNameForId (const int id);
 
 
IRODS_UTIL_LOCAL void ClearQueryResult (QueryResult *result_p);
 
 
IRODS_UTIL_API json_t *GetQueryResultAsJSON (const QueryResults * const results_p);
 
 
IRODS_UTIL_API json_t *GetQueryResultAsResourcesJSON (const QueryResults * const qrs_p);
 
 
IRODS_UTIL_API LinkedList *GetQueryResultsPaths (const QueryResults * const qrs_p);
 
 
IRODS_UTIL_API QueryResults *GetAllMetadataDataAttributeNames (struct IRodsConnection *connection_p);
 
 
 
IRODS_UTIL_API QueryResults *GetAllMetadataDataAttributeValues (struct IRodsConnection *connection_p, const char * const name_s);
 
 
IRODS_UTIL_API QueryResults *GetAllMetadataCollectionAttributeNames (struct IRodsConnection *connection_p);
 
 
IRODS_UTIL_API QueryResults *GetAllMetadataUserAttributeNames (struct IRodsConnection *connection_p);
 
 
IRODS_UTIL_LOCAL QueryResults *GetAllAttributeNames (struct IRodsConnection *connection_p, const int col_id);
 
 
IRODS_UTIL_API QueryResults *GetAllMetadataAttributeValues (struct IRodsConnection *connection_p, const int key_id, const char * const key_s, const int value_id);
 
 
 
#ifdef __cplusplus
}
#endif
 
#endif    /* #ifndef IRODS_QUERY_H */