README
1== Summary ==
2This directory contains RocksDB-based Storage Engine (RDBSE) for MySQL = "MyRocks".
3
4== Resources ==
5See https://github.com/facebook/mysql-5.6/wiki/Getting-Started-with-MyRocks
6Facebook group: https://www.facebook.com/groups/mysqlonrocksdb/
7
8== Coding Conventions ==
9The baseline for MyRocks coding conventions is the MySQL set, available at
10http://dev.mysql.com/doc/internals/en/coding-guidelines.html.
11
12Several refinements:
13 0. There is an umbrella C++ namespace named "myrocks" for all MyRocks code.
14 1. We introduced "RDB" as the super-short abbreviation for "RocksDB". We will
15 use it as a name prefix, with different capitalization (see below), to ease
16 up code navigation with ctags and grep.
17 N.B. For ease of matching, we'll keep the variables and functions dealing
18 with sysvars as close as possible to the outside visible names of
19 sysvars, which start with "rocksdb_" prefix, the outward storage
20 engine name.
21 2. The names for classes, interfaces, and C++ structures (which act as
22 classes), start with prefix "Rdb_".
23 NB: For historical reasons, we'll keep the "ha_<storage_engine_name>" class
24 name for ha_rocksdb class, which is an exception to the rule.
25 3. The names for global objects and functions start with prefix "rdb_".
26 4. The names for macros and constants start with prefix "RDB_".
27 5. Regular class member names start with "m_".
28 6. Static class member names start with "s_".
29 7. Given the 80 character per line limit, we'll not always use full English
30 words in names, when a well known or easily recognizable abbreviation
31 exists (like "tx" for "transaction" or "param" for "parameter" etc).
32 8. When needing to disambiguate, we use different suffixes for that, like
33 "_arg" for a function argument/parameter, "_arr" for a C style array, and
34 "_vect" for a std::vector etc.
35
36== Running Tests ==
37To run tests from rocksdb, rocksd_rpl or rocksdb_sys_vars packages, use the following parameters:
38--mysqld=--default-storage-engine=rocksdb --mysqld=--skip-innodb --mysqld=--default-tmp-storage-engine=MyISAM --mysqld=--rocksdb