Skip to content

Commit 0e45c50

Browse files
witold-swierzywitold-swierzy
authored
Update README.md
1 parent da2d64d commit 0e45c50

File tree

1 file changed

+45
-44
lines changed
  • data-platform/autonomous-database/autonomous-json/MongoDBReplay

1 file changed

+45
-44
lines changed

‎data-platform/autonomous-database/autonomous-json/MongoDBReplay/README.md

Lines changed: 45 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -42,53 +42,53 @@ See [LICENSE](https://github.com/oracle-devrel/technology-engineering/blob/main/
4242

4343
- The following configuration file $MR_CONFIG_DIR/MDBExtractConfig.json needs to be existing with the following parameters
4444

45-
OUTPUT_DIR : optional; points to directory where output files will be created;
46-
if this parameter is not set, then MDBExtractor will print out results into standard output
45+
- OUTPUT_DIR : optional; points to directory where output files will be created;
46+
if this parameter is not set, then MDBExtractor will print out results into standard output
4747

48-
INPUT_FILE : optional; points to an input log file generated by a MongoDB Instance with profiling enabled
49-
if this parameter is not set, then MDBExtractor will read data from standard input
48+
- INPUT_FILE : optional; points to an input log file generated by a MongoDB Instance with profiling enabled
49+
if this parameter is not set, then MDBExtractor will read data from standard input
5050

51-
INPUT_FILE_FORMAT : optional; provides information about from which file the data will be read. It accepts two values
51+
- INPUT_FILE_FORMAT : optional; provides information about from which file the data will be read. It accepts two values
5252
MONGO_LOG : in that case Extractor will be reading data from traditional Mongod log file. Profiling needs to be set to (0,-1)
5353
MONGO_PROFILE : in that case Extractor will be reading data from dump of db.system.profile collection. Profiling needs to be set to (2)
5454

55-
INPUT_CONNECT_STRING : optional; if set then it points to a MongoDB instance, from which input data will be read directly. Profiling needs to be set to (2). When this parameter is set, then INPUT_FILE and INPUT_FILE_FORMAT cannot be set.
55+
- INPUT_CONNECT_STRING : optional; if set then it points to a MongoDB instance, from which input data will be read directly. Profiling needs to be set to (2). When this parameter is set, then INPUT_FILE and INPUT_FILE_FORMAT cannot be set.
5656

57-
COMMANDS_LOGGING : optional; default value "true", if set to "true" then every command found by the extractor will be
58-
additional logged with console.log(...). Useful, when output will be processed by mongosh tool, which
59-
has limited capabilities related to error reporting. When set to "false" only commands will be reported.
57+
- COMMANDS_LOGGING : optional; default value "true", if set to "true" then every command found by the extractor will be
58+
additional logged with console.log(...). Useful, when output will be processed by mongosh tool, which
59+
has limited capabilities related to error reporting. When set to "false" only commands will be reported.
6060

61-
INCLUDE_COMMANDS : optional; JSON array allowing for providing list of commands, which will be extracted;
62-
all commands not listed here will not be printed out into output; this parameter CANNOT be used
63-
simultanously with EXCLUDE_COMMANDS
61+
- INCLUDE_COMMANDS : optional; JSON array allowing for providing list of commands, which will be extracted;
62+
all commands not listed here will not be printed out into output; this parameter CANNOT be used
63+
simultanously with EXCLUDE_COMMANDS
6464

65-
EXCLUDE_COMMANDS : optional; JSON array allowing for providing list of commands, which will be ignored during extraction process;
66-
all commands listed here will not be printed out into output; this parameter CANNOT be used
67-
simultanously with INCLUDE_COMMANDS
65+
- EXCLUDE_COMMANDS : optional; JSON array allowing for providing list of commands, which will be ignored during extraction process;
66+
all commands listed here will not be printed out into output; this parameter CANNOT be used
67+
simultanously with INCLUDE_COMMANDS
6868
if none of above parameters is set, then all commands will be traced
6969

70-
INCLUDE_DATABASES : optional; JSON array allowing for providing list of databases, which will be traced.
71-
all databases not listed here will not be traced.
72-
This parameter cannot be used simultaneously with EXCLUDE_DATABASES
70+
- INCLUDE_DATABASES : optional; JSON array allowing for providing list of databases, which will be traced.
71+
all databases not listed here will not be traced.
72+
This parameter cannot be used simultaneously with EXCLUDE_DATABASES
7373

74-
EXCLUDE_DATABASES : optional; JSON array allowing for providing list of databases, which will not be traced.
75-
all databases not listed here will be traced.
76-
This parameter cannot be used simultaneously with INCLUDE_DATABASES
74+
- EXCLUDE_DATABASES : optional; JSON array allowing for providing list of databases, which will not be traced.
75+
all databases not listed here will be traced.
76+
This parameter cannot be used simultaneously with INCLUDE_DATABASES
7777
if none of above parameters is set, then all databases will be traced
7878

79-
EXECUTION_PLAN_TRACING : if set to a non-zero value, then output will contain explain() commands instead of runCommand;
80-
useful, when there is need to check/compare execution plans between a source and a target system
79+
- EXECUTION_PLAN_TRACING : if set to a non-zero value, then output will contain explain() commands instead of runCommand;
80+
useful, when there is need to check/compare execution plans between a source and a target system
8181

82-
OUTPUT_MODE : can be set to JSON, which result in that the output data will be formated into sequence of JSON documents
83-
or to SCRIPT, wich will result in that the output data will be formated into NodeJS script, which can be
84-
consumed by mongosh
85-
LOG_FILE : name of log file used by the tool; optional; if not set then all diangostic messages will be redirected to
86-
standard diagnostic output
82+
- OUTPUT_MODE : can be set to JSON, which result in that the output data will be formated into sequence of JSON documents
83+
or to SCRIPT, wich will result in that the output data will be formated into NodeJS script, which can be
84+
consumed by mongosh
85+
- LOG_FILE : name of log file used by the tool; optional; if not set then all diangostic messages will be redirected to
86+
standard diagnostic output
8787

88-
LOG_LEVEL : optional; can be set to 0,1 or 2. Default value : 0
89-
0 means that only summary of initialization and processing will be logged
90-
1 means that additionally to summaries also errors will be logged
91-
2 means that additionally to summaries and errors all commands will be logged
88+
- LOG_LEVEL : optional; can be set to 0,1 or 2. Default value : 0
89+
0 means that only summary of initialization and processing will be logged
90+
1 means that additionally to summaries also errors will be logged
91+
2 means that additionally to summaries and errors all commands will be logged
9292

9393
Configuration File example:
9494
```
@@ -115,19 +115,20 @@ See [LICENSE](https://github.com/oracle-devrel/technology-engineering/blob/main/
115115
116116
### MDBApplier
117117
requirements
118-
- target MongoDB instance up and running
118+
- target Oracle Database (19c or later) with [Oracle API for MongoDB](https://docs.oracle.com/en/database/oracle/mongodb-api/mgapi/overview-oracle-database-api-mongodb.html#GUID-1CF44843-6294-45F0-8065-B9E8034D6CB1) enabled
119+
- subset of the data representing all collections which will be traced
119120
- the following configuration file $MR_CONFIG_DIR/MDBApplierConfig.json needs to be existing with the following parameters
120-
INPUT_FILE : optional; points to an input log file generated by MDBExtractor
121-
if this parameter is not set, then MDBApplier will read data from standard input
122-
DB_NAME : optional; allows for providing target database name
123-
CONNECT_STRING : mandatoryl; connect string to a target MongoDB or Oracle API for MongoDB instance
124-
LOG_FILE : name of log file used by the tool; optional; if not set then all diangostic messages will be redirected to
125-
standard diagnostic output
126-
127-
LOG_LEVEL : optional; can be set to 0,1 or 2. Default value : 0
128-
0 means that only summary of initialization and processing will be logged
129-
1 means that additionally to summaries also errors will be logged
130-
2 means that additionally to summaries and errors all commands will be logged
121+
- INPUT_FILE : optional; points to an input log file generated by MDBExtractor
122+
if this parameter is not set, then MDBApplier will read data from standard input
123+
- DB_NAME : optional; allows for providing target database name
124+
- CONNECT_STRING : mandatoryl; connect string to a target MongoDB or Oracle API for MongoDB instance
125+
- LOG_FILE : name of log file used by the tool; optional; if not set then all diangostic messages will be redirected to
126+
standard diagnostic output
127+
128+
- LOG_LEVEL : optional; can be set to 0,1 or 2. Default value : 0
129+
0 means that only summary of initialization and processing will be logged
130+
1 means that additionally to summaries also errors will be logged
131+
2 means that additionally to summaries and errors all commands will be logged
131132
132133
Configuration file example:
133134
```

0 commit comments

Comments
 (0)