schemaparser/README.txt

   1 MC-NIB Schema Parser library
   2
   3 Use this library to parse records fetched from the MC-NIB
   4
   5 The schema parser library consists of 7 files
   6         block_allocator.cc
   7         block_allocator.h
   8         json.cc
   9         json.h
  10         schemaparser.h
  11         schemaparser_impl.h
  12         schemaparser.cc
  13
  14 If you enter
  15         make
  16 you will build mc_schema.a.
  17
  18 To use the MC-NIB schema parser, include
  19         schemaparser.h
  20 and link against
  21         mc_schema.a
  22
  23 This directory also contains some examples and utilities.
  24 However to build them you need to have lsdl installed.
  25
  26 To build the examples and utilities, enter
  27         make utils
  28
  29 mc_extract
  30         This utility accepts table name and an optional key prefix.
  31         The utility will fetch all records in the MC-NIB from that table
  32         whose key matches the prefix and print formatted output.
  33         This utility also serves as an example of schema parser library usage.
  34         - mc_extract will attempt to fetch the schema from ther MC-NIB.
  35           If the schema isn't in the MC-NIB (see below), an optional parameter
  36           is the name of the schema file.  Use the provided file nib.json
  37
  38 sample2
  39         This example illustrates various ways of extracting fields using
  40         the schema parser.
  41
  42 mc_store_schema
  43         mc_extract will attempt to store a schema in the MC-NIB.
  44         Use this utility to store nib.json as the schema in the MC-NIB.
  45
  46 load_mcnib1
  47         This utility loads several records into the MC-NIB for mc_extract
  48         to fetch, using the table definition throughput_ue
  49
  50 mc_keys
  51         This utility will fetch all keys from MC-NIB which match an optional prefix
  52
  53 mc_extract_string
  54         This utility will fetch and print all strings in the MC-NIB which match
  55         an optional prefix.  No interpretation is done, so this utility is
  56         mostly useful for extracting the schema, under key _schema
  57
  58
  59