README 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. leveldb: A key-value store
  2. Authors: Sanjay Ghemawat (sanjay@google.com) and Jeff Dean (jeff@google.com)
  3. The code under this directory implements a system for maintaining a
  4. persistent key/value store.
  5. See doc/index.html for more explanation.
  6. See doc/impl.html for a brief overview of the implementation.
  7. The public interface is in include/*.h. Callers should not include or
  8. rely on the details of any other header files in this package. Those
  9. internal APIs may be changed without warning.
  10. Guide to header files:
  11. include/db.h
  12. Main interface to the DB: Start here
  13. include/options.h
  14. Control over the behavior of an entire database, and also
  15. control over the behavior of individual reads and writes.
  16. include/comparator.h
  17. Abstraction for user-specified comparison function. If you want
  18. just bytewise comparison of keys, you can use the default comparator,
  19. but clients can write their own comparator implementations if they
  20. want custom ordering (e.g. to handle different character
  21. encodings, etc.)
  22. include/iterator.h
  23. Interface for iterating over data. You can get an iterator
  24. from a DB object.
  25. include/write_batch.h
  26. Interface for atomically applying multiple updates to a database.
  27. include/slice.h
  28. A simple module for maintaining a pointer and a length into some
  29. other byte array.
  30. include/status.h
  31. Status is returned from many of the public interfaces and is used
  32. to report success and various kinds of errors.
  33. include/env.h
  34. Abstraction of the OS environment. A posix implementation of
  35. this interface is in util/env_posix.cc
  36. include/table.h
  37. include/table_builder.h
  38. Lower-level modules that most clients probably won't use directly