aboutsummaryrefslogtreecommitdiff
path: root/benchmarks/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'benchmarks/README.md')
-rw-r--r--benchmarks/README.md43
1 files changed, 42 insertions, 1 deletions
diff --git a/benchmarks/README.md b/benchmarks/README.md
index 21cd7352..72885886 100644
--- a/benchmarks/README.md
+++ b/benchmarks/README.md
@@ -5,7 +5,7 @@ This directory contains benchmarking schemas and data sets that you
can use to test a variety of performance scenarios against your
protobuf language runtime. If you are looking for performance
numbers of officially support languages, see [here](
-https://github.com/google/protobuf/blob/master/docs/Performance.md)
+https://github.com/protocolbuffers/protobuf/blob/master/docs/performance.md)
## Prerequisite
@@ -58,6 +58,13 @@ $ export PATH=$PATH:$(go env GOPATH)/bin
The first command installs `protoc-gen-go` into the `bin` directory in your local `GOPATH`.
The second command adds the `bin` directory to your `PATH` so that `protoc` can locate the plugin later.
+### PHP
+PHP benchmark's requirement is the same as PHP protobuf's requirements. The benchmark will automaticly
+include PHP protobuf's src and build the c extension if required.
+
+### Node.js
+Node.js benchmark need [node](https://nodejs.org/en/)(higher than V6) and [npm](https://www.npmjs.com/) package manager installed. This benchmark is using the [benchmark](https://www.npmjs.com/package/benchmark) framework to test, which needn't to manually install. And another prerequisite is [protobuf js](https://github.com/protocolbuffers/protobuf/tree/master/js), which needn't to manually install either
+
### Big data
There's some optional big testing data which is not included in the directory
@@ -120,6 +127,23 @@ $ make python-cpp-generated-code
$ make go
```
+
+### PHP
+We have two version of php protobuf implemention: pure php, php with c extension. To run these version benchmark, you need to:
+#### Pure PHP
+```
+$ make php
+```
+#### PHP with c extension
+```
+$ make php_c
+```
+
+### Node.js
+```
+$ make js
+```
+
To run a specific dataset or run with specific options:
### Java:
@@ -167,6 +191,23 @@ $ make go-benchmark
$ ./go-benchmark $(specific generated dataset file name) [go testing options]
```
+### PHP
+#### Pure PHP
+```
+$ make php-benchmark
+$ ./php-benchmark $(specific generated dataset file name)
+```
+#### PHP with c extension
+```
+$ make php-c-benchmark
+$ ./php-c-benchmark $(specific generated dataset file name)
+```
+
+### Node.js
+```
+$ make js-benchmark
+$ ./js-benchmark $(specific generated dataset file name)
+```
## Benchmark datasets