base/drms/libs/api/drms_record.h File Reference

Functions that retrieve, close, populate, copy, allocate, and free DRMS_Record_t structures. More...

#include "drms_types.h"
#include "db.h"
#include "list.h"

Include dependency graph for drms_record.h:

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

Go to the source code of this file.

Defines

#define kLocalPrimekey
#define kLocalPrimekeyType
#define kLocalSegName

Typedefs

typedef enum DRMS_RecChunking_enum DRMS_RecChunking_t

Enumerations

enum  DRMS_CloneAction_t { DRMS_COPY_SEGMENTS, DRMS_SHARE_SEGMENTS }
enum  DRMS_CloseAction_t { DRMS_FREE_RECORD, DRMS_INSERT_RECORD }
enum  DRMS_QueryType_t {
  DRMS_QUERY_COUNT, DRMS_QUERY_FL, DRMS_QUERY_ALL, DRMS_QUERY_N,
  DRMS_QUERY_PARTIAL
}
 DRMS query type.
enum  DRMS_RecChunking_enum { kRecChunking_None, kRecChunking_NoMoreRecs, kRecChunking_LastInChunk, kRecChunking_LastInRS }

FunctionsTitleTestFour

DRMS_Record_tdrms_clone_record (DRMS_Record_t *record, DRMS_RecLifetime_t lifetime, DRMS_CloneAction_t mode, int *status)
DRMS_RecordSet_tdrms_clone_records (DRMS_RecordSet_t *recset, DRMS_RecLifetime_t lifetime, DRMS_CloneAction_t mode, int *status)
DRMS_RecordSet_tdrms_clone_records_nosums (DRMS_RecordSet_t *recset, DRMS_RecLifetime_t lifetime, DRMS_CloneAction_t mode, int *status)
int drms_close_record (DRMS_Record_t *rec, int action)
int drms_close_records (DRMS_RecordSet_t *rs, int action)
int drms_count_records (DRMS_Env_t *env, const char *recordsetname, int *status)
DRMS_Record_tdrms_create_record (DRMS_Env_t *env, char *seriesname, DRMS_RecLifetime_t lifetime, int *status)
DRMS_RecordSet_tdrms_create_records (DRMS_Env_t *env, int n, const char *seriesname, DRMS_RecLifetime_t lifetime, int *status)
DRMS_Record_tdrms_create_recproto (DRMS_Record_t *recSource, int *status)
DRMS_RecordSet_tdrms_create_recprotos (DRMS_RecordSet_t *recset, int *status)
void drms_destroy_recproto (DRMS_Record_t **proto)
void drms_destroy_recprotos (DRMS_RecordSet_t **protos)
void drms_fprint_record (FILE *recfile, DRMS_Record_t *rec)
 Print the contents of a record data structure to a stream.
void drms_free_cursor (DRMS_RecSetCursor_t **cursor)
long long drms_keylist_memsize (DRMS_Record_t *rec, const char *keylist)
 Estimate how much memory is used for keywords in the keylist.
int drms_merge_record (DRMS_RecordSet_t *rs, DRMS_Record_t *rec)
DRMS_RecordSet_tdrms_open_nrecords (DRMS_Env_t *env, const char *recordsetname, int n, int *status)
DRMS_RecordSet_tdrms_open_records (DRMS_Env_t *env, const char *recordsetname, int *status)
DRMS_RecordSet_tdrms_open_recordset (DRMS_Env_t *env, const char *rsquery, int *status)
DRMS_RecordSet_tdrms_open_recordswithkeys (DRMS_Env_t *env, const char *specification, const char *keylist, int *status)
void drms_print_record (DRMS_Record_t *rec)
 Print the contents of a record data structure to stdout.
int drms_record_directory (DRMS_Record_t *rec, char *dirname, int retrieve)
 Find the Storage Unit directory associated with a record.
int drms_record_directory_nosums (DRMS_Record_t *rec, char *dirout, int size)
int drms_record_freerecsetspecarr (char **allvers, char ***sets, DRMS_RecordSetType_t **types, char ***snames, char ***filts, int nsets)
int drms_record_freerecsetspecarr_plussegs (char **allvers, char ***sets, DRMS_RecordSetType_t **types, char ***snames, char ***filts, char ***segs, int nsets)
int drms_record_getinfo (DRMS_RecordSet_t *rs)
DRMS_RecordSetType_t drms_record_getquerytype (const char *query)
DRMS_Array_tdrms_record_getvector (DRMS_Env_t *env, const char *recordsetname, const char *keylist, DRMS_Type_t type, int unique, int *status)
int drms_record_isdsds (DRMS_Record_t *rec)
int drms_record_islocal (DRMS_Record_t *rec)
char * drms_record_jsoc_version (DRMS_Env_t *env, DRMS_Record_t *rec)
long long drms_record_memsize (DRMS_Record_t *rec)
 Estimate how much memory is used per record.
DRMS_Keyword_tdrms_record_nextkey (DRMS_Record_t *rec, HIterator_t **last, int followlink)
DRMS_Link_tdrms_record_nextlink (DRMS_Record_t *rec, HIterator_t **last)
DRMS_Segment_tdrms_record_nextseg (DRMS_Record_t *rec, HIterator_t **last, int followlink)
DRMS_Segment_tdrms_record_nextseg2 (DRMS_Record_t *rec, HIterator_t **last, int followlink, DRMS_Segment_t **orig)
int drms_record_num_nonlink_segments (DRMS_Record_t *rec)
 Number of nonlink segments associated with a record.
int drms_record_numkeywords (DRMS_Record_t *rec)
 Number of keywords associated with a record.
int drms_record_numlinks (DRMS_Record_t *rec)
 Number of links associated with a record.
int drms_record_numsegments (DRMS_Record_t *rec)
 Number of segments associated with a record.
int drms_record_parserecsetspec (const char *recsetsStr, char **allvers, char ***sets, DRMS_RecordSetType_t **types, char ***snames, char ***filts, int *nsets, DRMS_RecQueryInfo_t *info)
int drms_record_parserecsetspec_plussegs (const char *recsetsStr, char **allvers, char ***sets, DRMS_RecordSetType_t **types, char ***snames, char ***filts, char ***segs, int *nsets, DRMS_RecQueryInfo_t *info)
long long drms_record_size (DRMS_Record_t *rec)
 Calculate size of a record and its segment arrays in bytes.
char * drms_recordset_acquireseriesname (const char *query)
DRMS_Record_tdrms_recordset_fetchnext (DRMS_Env_t *env, DRMS_RecordSet_t *rs, int *drmsstatus, DRMS_RecChunking_t *chunkstat, int *newchunk)
int drms_recordset_fetchnext_getcurrent (DRMS_RecordSet_t *rset)
void drms_recordset_fetchnext_setcurrent (DRMS_RecordSet_t *rset, int current)
unsigned int drms_recordset_getchunksize ()
const char * drms_recordset_getqueryss (DRMS_RecordSet_t *rs, unsigned int setnum, int *status)
 Return a DRMS record-set subset query.
DRMS_Record_tdrms_recordset_getss (DRMS_RecordSet_t *set, unsigned int setnum, int *status)
 Return a DRMS record-set subset.
int drms_recordset_getssnrecs (DRMS_RecordSet_t *set, unsigned int setnum, int *status)
 Return the number of records in a DRMS record-set subset.
DRMS_RecordSetType_t * drms_recordset_gettypess (DRMS_RecordSet_t *rs, unsigned int setnum, int *status)
 Return a DRMS record-set subset query type.
int drms_recordset_setchunksize (unsigned int size)
int drms_recproto_setseriesinfo (DRMS_Record_t *rec, int *unitSize, int *bArchive, int *nDaysRetention, int *tapeGroup, const char *description)
int drms_sortandstage_records (DRMS_RecordSet_t *rs, int retrieve, int dontwait, HContainer_t **suinfo)
int drms_stage_records (DRMS_RecordSet_t *rs, int retrieve, int dontwait)


Detailed Description

Functions that retrieve, close, populate, copy, allocate, and free DRMS_Record_t structures.

See also:
drms_keymap.h drms_keyword.h drms_segment.h drms_series.h drms_env.h

Definition in file drms_record.h.


Generated on Sat May 27 07:00:40 2017 for JSOC_Documentation by  doxygen 1.5.7.1