Home Explore Help
Sign In
SMusatov
/
ydb
mirror of https://github.com/ydb-platform/ydb.git
1
0
Fork 0
Files
Tree: 6bb28dfd11
Branches Tags
ydb
/
contrib
/
libs
/
apache
/
avro
/
README

README 2.1 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869 
  1. Avro C++ README.txt
    2. 

  2. 

  3. The C++ port is thus far incomplete.  Currently, it contains:
    4. 

  4. 

  5.  - Serializer/Parser- objects for writing/reading raw binary.
    6. 

  6. 

  7.  - xxxSchema- objects for composing schemas.
    8. 

  8. 

  9.  - ValidSchema- a schema object that has been converted to a parse tree
    10. 

  10.    (with some sanity checks).
    11. 

  11. 

  12.  - ValidSchema.toJson() writes the schema as a json object.
    13. 

  13. 

  14.  - ValidatingSerializer/ValidatingParser- check that reads/writes
    15. 

  15.    match the expected schema type (more expensive than the raw
    16. 

  16.    serializer/parser but they detect errors, and allow dynamic
    17. 

  17.    discovery of parsed data/attributes).
    18. 

  18. 

  19.  - Compiler (compileJsonSchema())- converts a Json string schema to a
    20. 

  20.    ValidSchema.
    21. 

  21. 

  22.  - Code Generation (experimental) - given a schema it generates C++
    23. 

  23.    objects of the same data types, and the code to serialize and parse
    24. 

  24.    it.
    25. 

  25. 

  26. What's missing: Rpc containers are not yet implemented. Documentation is sparse.
    27. 

  27. 

  28. INSTRUCTIONS
    29. 

  29. 

  30. Pre-requisites:
    31. 

  31. 

  32. To compile requires boost headers, and the boost regex library. Optionally, it requires Snappy compression library. If Snappy is available, it builds support for Snappy compression and skips it otherwise. (Please see your OS-specific instructions on how to install Boost and Snappy for your OS).
    33. 

  33. 

  34. To build one requires cmake 2.6 or later.
    35. 

  35. 

  36. To generate a Makefile under Unix, MacOS (using GNU) or Cygwin use:
    37. 

  37. 

  38. mkdir build
    39. 

  39. cd build
    40. 

  40. cmake -G "Unix Makefiles" ..
    41. 

  41. 

  42. If it doesn't work, either you are missing some packages (boost, flex or bison),
    43. 

  43. or you need to help configure locate them.
    44. 

  44. 

  45. If the Makefile is configured correctly, then you can make and run tests:
    46. 

  46. 

  47.     make
    48. 

  48.     ctest
    49. 

  49. 

  50. To install
    51. 

  51. 

  52.     make package
    53. 

  53. 

  54. and then untar the generated .tar.gz file.
    55. 

  55. 

  56. To build and test on MacOS (using Xcode)
    57. 

  57. 

  58. mkdir build.mac
    59. 

  59. cd build.mac
    60. 

  60. cmake -G Xcode
    61. 

  61. 

  62. xcodebuild -configuration Release
    63. 

  63. ctest -C Release
    64. 

  64. 

  65. If debug version is required, replace 'Release' above with 'Debug'.
    66. 

  66. 

  67. Note: The LICENSE and NOTICE files in the lang/c++ source directory are used to
    68. 

  68. build the binary distribution. The LICENSE and NOTICE information for the Avro
    69. 

  69. C++ source distribution is in the root directory.
    70.