Merge branch 'refs/heads/t/lopsub'
[osl.git] / README
1 libosl, the object storage layer, is a library for storing small to
2 medium-sized data in relational tables. It is easy to use, lightweight,
3 fast and portable. libosl is suitable for applications that need
4 only a small fraction of the features a full database management
5 system provides.
6
7 Libosl is simple:
8
9 - For libosl, all data stored in the osl tables are blobs,
10 libosl will never try to interpret the table contents.
11
12 - There is no fancy query language but only a relatively
13 simple C-API.
14
15 - There's no support for network-access and libosl only uses a very
16 rudimentary table locking mechanism.
17
18 - There are no dependencies on external libraries. An augmented
19 version of the red-black tree implementation of the linux
20 kernel is in included in the libosl package.
21
22 Libosl is fast:
23
24 - It uses sha1 hashes for content-based addressing.
25
26 - Red-black trees are used to make lookups fast.
27
28 Libosl is portable:
29
30 - It is known to compile and run on Linux, MacOS, FreeBSD,
31 NetBSD and Solaris.
32
33 - Content and metadata is stored in an endian-agnostic way.
34
35 Libosl is open source:
36
37 - Licensed under the GPL, version 2.
38
39 Apart from the library itself, the package also contains simple
40 examples and an fsck program, oslfsck, which can be used to recover
41 from corrupted tables due to system crashes or bugs in the application
42 or the library.