diff --git a/docs/src/how_to_build.md b/docs/src/how_to_build.md index 5e8eb938cf44e48080d37b3446625626a33bd424..ab64a8c1538d6a8c74fa59e60f90c2b8aac45e21 100644 --- a/docs/src/how_to_build.md +++ b/docs/src/how_to_build.md @@ -37,16 +37,5 @@ bash build.sh release 此命令将编译release版本的miniob。 -**FAQ** -1. 运行observer出现找不到链接库 -A: 由于安装依赖时,默认安装在 `/usr/local/` 目录下,而环境变量中没有将这个目录包含到动态链接库查找路径。可以将下面的命令添加到 HOME 目录的 `.bashrc` 中: -```bash -export LD_LIBRARY_PATH=/usr/local/lib64:$LD_LIBRARY_PATH -``` -然后执行 `source ~/.bashrc` 加载环境变量后重新启动程序。 - -LD_LIBRARY_PATH 是Linux环境中,运行时查找动态链接库的路径,路径之间以冒号':'分隔。 - -将数据写入 bashrc 或其它文件,可以在下次启动程序时,会自动加载,而不需要再次执行 source 命令加载。 - -> NOTE: 如果你的终端脚本使用的不是bash,而是zsh,那么就需要修改 .zshrc。 +3. 运行 +参考 [如何运行](how_to_run.md) diff --git a/docs/src/how_to_run.md b/docs/src/how_to_run.md index 64dc2ba78b742dbf6e220030ae07c4cdd906e724..4116b95d36327d0bf44c2c0df5e60e9dcda3cc3d 100644 --- a/docs/src/how_to_run.md +++ b/docs/src/how_to_run.md @@ -47,6 +47,33 @@ bash build.sh -DCONCURRENCY=ON 然后使用上面的命令启动服务端程序,就可以支持并发了。 +**启动参数介绍** + +| 参数 | 说明 | +| ----------- | ----------- | +| -h | 帮助说明 | +| -f | 配置文件路径。如果不指定,就会使用默认值 ../etc/observer.ini。 | +| -p | 服务端监听的端口号。如果不指定,并且没有使用unix socket或cli的方式启动,就会使用配置文件中的值,或者使用默认值。 | +| -s | 服务端监听的unix socket文件。如果不指定,并且没有使用TCP或cli的方式启动,就会使用TCP的方式启动服务端。 | +| -P | 使用的通讯协议。当前支持文本协议(plain,也是默认值),MySQL协议(mysql),直接交互(cli)。
使用plain协议时,请使用自带的obclient连接服务端。
使用mysql协议时,使用mariadb或mysql客户端连接。
直接交互模式(cli)不需要使用客户端连接,因此无法开启多个连接。 | +| -t | 事务模型。没有事务(vacuous,默认值)和MVCC(mvcc)。 使用mvcc时一定要编译支持并发模式的代码。 | +| -n | buffer pool 的内存大小,单位字节。 | + **更多** observer还提供了一些其它参数,可以通过`./bin/observer -h`查看。 + +**FAQ** + +1. 运行observer出现找不到链接库 +A: 由于安装依赖时,默认安装在 `/usr/local/` 目录下,而环境变量中没有将这个目录包含到动态链接库查找路径。可以将下面的命令添加到 HOME 目录的 `.bashrc` 中: +```bash +export LD_LIBRARY_PATH=/usr/local/lib64:$LD_LIBRARY_PATH +``` +然后执行 `source ~/.bashrc` 加载环境变量后重新启动程序。 + +LD_LIBRARY_PATH 是Linux环境中,运行时查找动态链接库的路径,路径之间以冒号':'分隔。 + +将数据写入 bashrc 或其它文件,可以在下次启动程序时,会自动加载,而不需要再次执行 source 命令加载。 + +> NOTE: 如果你的终端脚本使用的不是bash,而是zsh,那么就需要修改 .zshrc。 \ No newline at end of file