Memurai

https://docs.memurai.com
Admin
Memurai is a Redis-compatible in-memory data store designed for Windows and Linux, providing...
Tokens:16,505
Snippets:160
Trust Score:7.9
Update:9 months ago
Show doc for...
Tokens:
Raw
### Memurai SQL: Query Index

Source: https://docs.memurai.com/en/msql-quickstart

This section demonstrates how to search an index table using the `MSQL.QUERY` command, similar to SQL queries.

```APIDOC
## MSQL.QUERY

### Description
Searches an in-memory index table using SQL-like syntax.

### Method
COMMAND

### Endpoint
`MSQL.QUERY "SELECT [column1], [column2] FROM [table_name] WHERE [condition]"`

### Parameters
#### Path Parameters
- **table_name** (string) - Required - The name of the index table to query.
- **column_name** (string) - Required - The name of the column to select.
- **condition** (string) - Optional - The filtering condition for the query.

### Request Example
```
127.0.0.1:6379> MSQL.QUERY "SELECT Name, Company FROM customers_idx"
```

### Response
#### Success Response (200)
- **Array of results**: Each inner array represents a row with selected column values.

#### Response Example
```
1) 1) "Name"
   2) "Company"
2) 1) "Max Jones"
   2) "XYZ Inc"
3) 1) "Paul Spellman"
   2) "Widgets Inc"
4) 1) "Ray Brown"
   2) "Acme Ltd"
```
```

--------------------------------

### Example Memurai SQL Configuration File

Source: https://docs.memurai.com/en/msql-config

An example configuration file for Memurai SQL, demonstrating the 'num_threads' and 'metadata_persistence' settings. This file follows the Valkey configuration format.

```text
num_threads 8
metadata_persistence ON
```

--------------------------------

### Memurai SQL: Create Index

Source: https://docs.memurai.com/en/msql-quickstart

This section explains how to create an in-memory index table using the `MSQL.CREATE` command. It covers specifying the table name, data type, and source data.

```APIDOC
## MSQL.CREATE

### Description
Creates an in-memory index table for related entries sharing a common prefix.

### Method
COMMAND

### Endpoint
`MSQL.CREATE [table_name] ON HASH [key_prefix] [column_name1] [data_type1] ...`

### Parameters
#### Path Parameters
- **table_name** (string) - Required - The name of the index table to create.
- **key_prefix** (string) - Required - The common prefix of the keys to index.
- **column_name** (string) - Required - The name of the column in the index table.
- **data_type** (string) - Required - The data type for the column (e.g., TEXT, BIGINT, FLOAT).

### Request Example
```
127.0.0.1:6379> MSQL.CREATE customers_idx ON HASH Customer: Name TEXT Company TEXT Contact_Number BIGINT
```

### Response
#### Success Response (200)
- **Table created**: The name of the created table.
- **scanned**: The number of keys scanned.
- **NULLs in column**: The count of NULL values for each column.

#### Response Example
```
1) "Table created: 'customers_idx'"
2) "scanned 3 keys."
3) "0 NULLs in column Name"
4) "0 NULLs in column Company"
5) "0 NULLs in column Contact_Number"
```
```

--------------------------------

### Start Memurai Server Instance with Systemctl (Bash)

Source: https://docs.memurai.com/en/linux-templated-service

This command demonstrates how to start a new memurai-server instance using systemctl. The 'myname' part in 'memurai-server@myname.service' corresponds to the custom configuration file name, allowing for distinct instance management.

```bash
sudo systemctl start memurai-server@myname.service
```

--------------------------------

### Install Memurai as a Service with TLS Configuration

Source: https://docs.memurai.com/en/config-tls

This command installs Memurai as a Windows service. It specifies the service name and points to a configuration file (`memurai-tls.conf`) that contains the necessary TLS settings, such as certificate and key file paths. This command must be run with administrative privileges.

```bash
memurai.exe --service-install --service-name "memurai" memurai-tls.conf
```

--------------------------------

### Custom Silent Memurai Installation (Windows)

Source: https://docs.memurai.com/en/installation

Performs a silent Memurai installation with custom options. This example installs to a specific folder, adds it to the PATH, and skips installing Memurai as a Windows service.

```shell
C:\>msiexec /quiet /i Memurai.msi INSTALLFOLDER="C:\MyApps\Memurai" ADD_INSTALLFOLDER_TO_PATH=1 INSTALL_SERVICE=0
```

--------------------------------

### Set Hash Entries for Indexing (Memurai/Valkey)

Source: https://docs.memurai.com/en/msql-quickstart

Initializes or updates hash entries in Memurai or Valkey, which can then be indexed by Memurai SQL. This demonstrates setting multiple fields within a hash key.

```redis
127.0.0.1:6379> hset Customer:001 Name "Paul Spellman" Company "Widgets Inc" Contact_Number 123456789
```

```redis
127.0.0.1:6379> hset Customer:002 Name "Max Jones" Company "XYZ Inc" Contact_Number 912334234
```

```redis
127.0.0.1:6379> hset Customer:003 Name "Ray Brown" Company "Acme Ltd" Contact_Number 893345834
```

--------------------------------

### Memurai SQL: Add Data to Index

Source: https://docs.memurai.com/en/msql-quickstart

This section explains how data added to the underlying Memurai or Valkey hashes is automatically reflected in the index table.

```APIDOC
## Add Data to Index

### Description
Data added to the source hashes in Memurai or Valkey is automatically updated in the corresponding index table.

### Method
COMMAND (for adding data to source hash)

### Endpoint
`HSET [key] [field1] [value1] ...`

### Request Example
```
127.0.0.1:6379> hset Customer:004 Name "Robert Johnson" Company "BigCo Inc" Contact_Number 789123456
```

### Note
Subsequent queries to the index table will include the newly added data.
```

--------------------------------

### Automatically Load Memurai SQL Module (Windows)

Source: https://docs.memurai.com/en/msql-install

Configures Memurai/Valkey to automatically load the Memurai SQL module on server startup by specifying the module path in the configuration file on Windows.

```ini
loadmodule C:\somepath\memurai-sql.dll
```

--------------------------------

### Automatically Load Memurai SQL Module (Linux)

Source: https://docs.memurai.com/en/msql-install

Configures Memurai/Valkey to automatically load the Memurai SQL module on server startup by specifying the module path in the configuration file on Linux.

```ini
loadmodule /somepath/libmemurai-sql.so
```

--------------------------------

### Silent Memurai Installation (Windows)

Source: https://docs.memurai.com/en/installation

Installs Memurai using the MSI setup with default settings without user interaction. Requires administrative privileges and an elevated command prompt.

```shell
C:\>msiexec /quiet /i Memurai.msi
```

--------------------------------

### Custom Memurai Installation (Windows MSI)

Source: https://docs.memurai.com/index

Installs Memurai with custom parameters, such as specifying the installation folder, adding it to the PATH, and choosing whether to install it as a Windows service. This command should be run from an elevated command prompt.

```batch
C:\>msiexec /quiet /i Memurai.msi INSTALLFOLDER="C:\MyApps\Memurai" ADD_INSTALLFOLDER_TO_PATH=1 INSTALL_SERVICE=0
```

```batch
C:\>msiexec /quiet /i Memurai.msi ADD_INSTALLFOLDER_TO_PATH=0 PORT=8000
```

--------------------------------

### Custom Silent Memurai Installation with Port and Firewall Rule (Windows)

Source: https://docs.memurai.com/en/installation

Performs a silent Memurai installation, customizing the port number and enabling a Windows Firewall rule. This example does not add the installation folder to the PATH but installs Memurai as a service on port 8000.

```shell
C:\>msiexec /quiet /i Memurai.msi ADD_INSTALLFOLDER_TO_PATH=0 PORT=8000
```

--------------------------------

### Manually Load Memurai SQL Module (Windows)

Source: https://docs.memurai.com/en/msql-install

Loads the Memurai SQL module into a Memurai/Valkey server using the `module load` command on Windows. This requires the absolute path to the DLL file.

```shell
C:\>memurai-cli module load C:\somepath\memurai-sql.dll
```

--------------------------------

### Query data, compare texts

Source: https://docs.memurai.com/en/commands

Shows examples of querying data from indexes ('transactions_idx', 'myguids') with specific text conditions on columns like 'ip_addr', 'geography', and 'device'.

```MSQL
MSQL.QUERY "SELECT ip_addr, geography, event_date from transactions_idx where ip_addr = '9.12.345.987'"
```

```MSQL
MSQL.QUERY "SELECT ip_addr, geography from transactions_idx WHERE event_date = '10-10-2020' ORDER BY geography"
```

```MSQL
MSQL.QUERY "SELECT guid, ip_addr from myguids where device = 'iphone'"
```

--------------------------------

### Memurai Service Configuration File for TLS

Source: https://docs.memurai.com/en/config-tls

This is an example configuration file for a Memurai Windows service. It specifies the file paths for the server's TLS certificate, private key, and the CA certificate. When Memurai is run as a service, it reads these settings from the specified configuration file to enable TLS communication.

```ini
tls-cert-file tls/server.crt
tls-key-file tls/server.key
tls-ca-cert-file tls/ca.crt
```

--------------------------------

### Memurai SQL: Destroy Index

Source: https://docs.memurai.com/en/msql-quickstart

This section shows how to remove an index table from the datastore using the `MSQL.DESTROY` command.

```APIDOC
## MSQL.DESTROY

### Description
Removes an index table from the in-memory datastore.

### Method
COMMAND

### Endpoint
`MSQL.DESTROY [table_name]`

### Parameters
#### Path Parameters
- **table_name** (string) - Required - The name of the index table to destroy.

### Request Example
```
127.0.0.1:6379> MSQL.DESTROY customers_idx
```

### Response
#### Success Response (200)
- **Table dropped**: Confirmation message indicating the table has been removed.

#### Response Example
```
1) "msql.destroy: Table customers_idx dropped."
```
```

--------------------------------

### Query data, offset and limit

Source: https://docs.memurai.com/en/commands

Illustrates how to control the number of results returned and their starting point using 'LIMIT' and 'OFFSET' clauses in queries.

```MSQL
MSQL.QUERY "SELECT ip_addr from transactions_idx ORDER BY ip_addr limit 2"
```

```MSQL
MSQL.QUERY "SELECT ip_addr from transactions_idx ORDER BY ip_addr offset 2"
```

```MSQL
MSQL.QUERY "SELECT ip_addr from transactions_idx ORDER BY ip_addr limit 2 offset 2"
```

--------------------------------

### Manually Load Memurai SQL Module (Linux)

Source: https://docs.memurai.com/en/msql-install

Loads the Memurai SQL module into a Memurai/Valkey server using the `module load` command on Linux. This requires the absolute path to the shared object file.

```shell
$ valkey-cli module load /somepath/libmemurai-sql.so
```

--------------------------------

### Add Data to Memurai SQL Indexed Hashes

Source: https://docs.memurai.com/en/msql-quickstart

Adds new hash entries to Memurai (or Valkey). These entries, when matching the prefix used during index creation, are automatically reflected in the Memurai SQL index upon subsequent queries.

```redis
127.0.0.1:6379> hset Customer:004 Name "Robert Johnson" Company "BigCo Inc" Contact_Number 789123456
```

--------------------------------

### Create Memurai SQL Index

Source: https://docs.memurai.com/en/msql-quickstart

Creates an in-memory index table for hash entries sharing a common prefix. It specifies the table name, data type (HASH), prefix, and column names with their respective data types (e.g., TEXT, BIGINT).

```sql
127.0.0.1:6379> MSQL.CREATE customers_idx ON HASH Customer: Name TEXT Company TEXT Contact_Number BIGINT
```

--------------------------------

### Query data, timestamp comparisons

Source: https://docs.memurai.com/en/commands

Provides examples of querying data based on timestamp comparisons using operators like '>', '>=', and '<=' on the 'timestamp_start' column.

```MSQL
MSQL.QUERY "SELECT ip_addr from myguids where timestamp_start > '2021-08-15T12:02:03'"
```

```MSQL
MSQL.QUERY "SELECT ip_addr from transactions_idx where timestamp_start >= '2021-08-14T12:10:15'"
```

```MSQL
MSQL.QUERY "SELECT ip_addr from transactions_idx where timestamp_start <= '2021-08-14T13:15:02'"
```

--------------------------------

### Search Memurai SQL Index

Source: https://docs.memurai.com/en/msql-quickstart

Queries an existing Memurai SQL index table to retrieve specific columns. This command allows for SQL-like SELECT statements to filter and retrieve data from the in-memory index.

```sql
127.0.0.1:6379> MSQL.QUERY "SELECT Name, Company FROM customers_idx"
```

--------------------------------

### Destroy Data with MSQL.DESTROY

Source: https://docs.memurai.com/en/commands

This example shows how to use the MSQL.DESTROY command to remove data from Memurai. Ensure you understand the implications before executing this command, as it is irreversible.

```msql
MSQL.DESTROY mymovies
```

--------------------------------

### Get index size

Source: https://docs.memurai.com/en/commands

The MSQL.SIZE command returns the total number of rows present in a specified index. This count dynamically updates as data is added or removed.

```MSQL
MSQL.SIZE mymovies
```

--------------------------------

### Drop Memurai SQL Index

Source: https://docs.memurai.com/en/msql-quickstart

Removes a Memurai SQL index table from the in-memory datastore. This command permanently deletes the specified index and its associated metadata.

```sql
127.0.0.1:6379> MSQL.DESTROY customers_idx
```

--------------------------------

### Load Memurai SQL Configuration on Windows

Source: https://docs.memurai.com/en/msql-config

Command to load the Memurai SQL module with a specified configuration file on Windows. Requires the path to the 'memurai-sql.dll' and the configuration file.

```bash
C:\>memurai-cli module load C:\somepath\memurai-sql.dll configfile.txt
```

--------------------------------

### Control Memurai Service with TLS

Source: https://docs.memurai.com/en/config-tls

These commands manage the Memurai Windows service. `--service-start` initiates the service, while `--service-stop` halts it. The `--service-name` flag is used to identify the specific Memurai service to be controlled. These commands allow for basic service lifecycle management.

```bash
# Start it with
memurai.exe --service-start --service-name "memurai"

# Stop it with
memurai.exe --service-stop --service-name "memurai"
```

--------------------------------

### Configure Memurai Persistence and Network Settings (Bash)

Source: https://docs.memurai.com/en/linux-templated-service

This snippet shows essential configuration parameters for a new memurai-server instance. It covers the database filename, append-only directory, port, UNIX socket, log file, and PID file. Modifying these prevents conflicts between multiple instances.

```bash
# The filename where to dump the DB
dbfilename dump-myname.rdb

# The directory where to store append-only persistence files
appenddirname "appendonlydir-myname"

# Set to 0 to only listen on the UNIX socket or to some other non-conflinting port number
port 0

# Set this to listen on the specified UNIX socket instead of/in addition to TCP
unixsocket /run/memurai-myname/memurai-server.sock

# Set the log file name
logfile /var/log/memurai/memurai-server-myname.log

# Set the pid file name
pidfile /run/memurai-myname/memurai-server.pid
```

--------------------------------

### Query data, order by

Source: https://docs.memurai.com/en/commands

Demonstrates how to query data from the 'transactions_idx' index and order the results by different columns like 'ip_addr' and 'event_date'.

```MSQL
MSQL.QUERY "SELECT ip_addr, event_date from transactions_idx"
```

```MSQL
MSQL.QUERY "SELECT ip_addr, event_date from transactions_idx ORDER BY ip_addr"
```

```MSQL
MSQL.QUERY "SELECT ip_addr, event_date from transactions_idx ORDER BY event_date"
```

--------------------------------

### Load Memurai SQL Configuration on Linux

Source: https://docs.memurai.com/en/msql-config

Command to load the Memurai SQL module with a specified configuration file on Linux. Requires the path to 'libmemurai-sql.so' and the configuration file.

```bash
$ valkey-cli module load /somepath/libmemurai-sql.so configfile.txt
```

--------------------------------

### Run Memurai Standalone with TLS

Source: https://docs.memurai.com/en/config-tls

This command runs the Memurai executable as a standalone process with TLS support enabled. It specifies the paths to the server's TLS certificate, private key, and the CA certificate. This method is suitable for testing but not recommended for production environments where Memurai should run as a service.

```bash
memurai.exe --tls-cert-file tls/server.crt \
        --tls-key-file tls/server.key \
        --tls-ca-cert-file tls/ca.crt
```

--------------------------------

### Query data, like patterns

Source: https://docs.memurai.com/en/commands

Demonstrates using the 'LIKE' operator with wildcards ('%', '_') to search for patterns within string data in columns like 'ip_addr' and 'product_no'.

```MSQL
MSQL.QUERY "SELECT ip_addr, product_no from transactions_idx where ip_addr like '%345'"
```

```MSQL
MSQL.QUERY "SELECT ip_addr, product_no from transactions_idx where ip_addr like '9.12%'"
```

```MSQL
MSQL.QUERY "SELECT ip_addr, product_no from transactions_idx where ip_addr like '%345%'"
```

--------------------------------

### Query data, query parameters

Source: https://docs.memurai.com/en/commands

Demonstrates the use of query parameters ('?') to safely and efficiently pass values into 'WHERE' clauses, supporting single and multiple parameters.

```MSQL
MSQL.QUERY "SELECT ip_addr from transactions_idx where product_no > ?" "2"
```

```MSQL
MSQL.QUERY "SELECT ip_addr from transactions_idx where product_no > ? and weight < ?" "2" "7.8"
```

```MSQL
MSQL.QUERY "SELECT ip_addr from transactions_idx where product_no > ? or weight < ?" "3" "5.0"
```

--------------------------------

### MSQL.QUERY commonalities with SQL

Source: https://docs.memurai.com/en/commands

Highlights the subset of SQL commands and operators supported by MSQL.QUERY, including ORDER BY, OFFSET, LIMIT, simple projections, WHERE clauses, and LIKE patterns. It also notes unsupported features like the asterisk wildcard and JOINs.

```MSQL
MSQL.QUERY “SELECT name FROM students WHERE grade = ? AND country = ?;" "actual" "expected"
```

--------------------------------

### MSQL.CREATE Index Creation

Source: https://docs.memurai.com/en/commands

The MSQL.CREATE command allows you to create an index table for a particular group of related entries that share a common prefix. You can index hash sub-fields by specifying their name and type.

```APIDOC
## MSQL.CREATE

### Description
The `MSQL.CREATE` command allows you to create an index table for a particular group of related entries that share a common prefix. It is possible to index any number of the "hash" sub-fields by specifying their name (column name) and their type.
_Note:_ If the type specified in an index table does not match the data type stored in Memurai (or Valkey), Memurai SQL will automatically do the conversion.

### Method
MSQL.CREATE

### Endpoint
N/A (This is a command, not an HTTP endpoint)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Syntax
```
MSQL.CREATE {INDEXNAME} ON hash {PREFIX} {COL1NAME} {COL1TYPE} [ {COL2NAME} {COL2TYPE} ,…. ] ]
```

- `{INDEXNAME}`: string - The name of the index to be created.
- `{PREFIX}`: string - The common prefix for the entries to be indexed.
- `{COL?NAME}`: string - The name of a field present in the hash object with the given prefix.
- `{COL?TYPE}`: one of: TEXT, BIGINT, FLOAT, DATE, TIMESTAMP - The data type of the column.

Supported Data Types:
- **TEXT**: Strings, supports UTF8 with limitations on binary zeros in query parameters.
- **BIGINT**: 64-bit signed integer numbers.
- **FLOAT**: 64-bit floating-point numbers.
- **DATE**: ISO 8601 format (`YYYY-mm-dd`).
- **TIMESTAMP**: ISO 8601 format with time (`YYYY-mm-ddTHH:MM:ss.millis`).

### Request Example
```
MSQL.CREATE myproducts ON hash "product:" id TEXT quantity BIGINT rating FLOAT type TEXT
```

### Response
#### Success Response (200)
Indicates successful index creation. Specific return value may vary, but typically confirms the operation.

#### Response Example
```
OK
```
```

--------------------------------

### Check and Fix Memurai AOF Files using memurai-check-aof.exe

Source: https://docs.memurai.com/en/check-aof-rdb

The `memurai-check-aof.exe` tool is used to inspect and optionally repair Append Only File (AOF) persistence files used by Memurai. It can report issues without making changes or attempt to fix them when the '--fix' flag is used. This tool is installed alongside the Memurai executable.

```bash
memurai-check-aof.exe <filename> # Check specified file and report issues without fixing them
memurai-check-aof.exe --fix <filename> # Check specified file and try to fix any issues
```

--------------------------------

### Verify Memurai Configuration File (Bash)

Source: https://docs.memurai.com/en/linux-templated-service

This command allows you to verify that a specific memurai-server instance is using the correct configuration file. It connects to the instance via its UNIX socket and queries the 'config_file' info.

```bash
memurai-cli -s /var/run/memurai-myname/memurai-server.sock info | grep config_file
```

--------------------------------

### Query data, And/Or comparisons

Source: https://docs.memurai.com/en/commands

Shows how to combine multiple conditions in a 'WHERE' clause using 'AND' and 'OR' operators for more complex data filtering.

```MSQL
MSQL.QUERY "SELECT ip_addr from transactions_idx where product_no > 1 and product_no < 5"
```

```MSQL
MSQL.QUERY "SELECT ip_addr from transactions_idx where product_no > 1 or product_no < 5"
```

```MSQL
MSQL.QUERY "SELECT ip_addr from transactions_idx where product_no >= 3 and weight < 7.0"
```

```MSQL
MSQL.QUERY "SELECT ip_addr from transactions_idx where product_no > 1 or ip_addr = '9.12.345.987'"
```

--------------------------------

### Create Index Table with MSQL.CREATE

Source: https://docs.memurai.com/en/commands

The MSQL.CREATE command allows the creation of index tables for related entries sharing a common prefix. It supports indexing multiple hash sub-fields by specifying their name and data type, with automatic type conversion if necessary. Supported data types include TEXT, BIGINT, FLOAT, DATE, and TIMESTAMP.

```memurai-sql
MSQL.CREATE myproducts ON hash "product:" id TEXT quantity BIGINT rating FLOAT type TEXT

```

```memurai-sql
MSQL.CREATE mymovies ON hash "movie:" title TEXT release_year BIGINT rating FLOAT genre TEXT

```

```memurai-sql
MSQ.CREATE transactions_idx ON hash "transaction:" ip_addr TEXT geography TEXT product_no BIGINT event_date DATE

```

```memurai-sql
MSQL.CREATE myguids on hash "guid:" guid TEXT ip_addr TEXT pages_visited BIGINT timestamp_start TIMESTAMP device TEXT OS TEXT browser TEXT

```

--------------------------------

### Default Memurai Configuration Settings

Source: https://docs.memurai.com/en/config-file

This snippet displays the default configuration values for Memurai when no configuration file is explicitly provided. These settings cover various aspects of Memurai's operation, including persistence, networking, and memory management. They are presented in a format suitable for a Memurai configuration file.

```memurai-config
activerehashing yes
aof-load-truncated yes
aof-rewrite-incremental-fsync yes
aof-use-rdb-preamble yes
appendfsync everysec
appendonly no
auto-aof-rewrite-min-size 64mb
auto-aof-rewrite-percentage 100
client-output-buffer-limit normal 0 0 0
client-output-buffer-limit slave 268435456 67108864 60
client-output-buffer-limit pubsub 33554432 8388608 60
client-query-buffer-limit 1gb
cluster-announce-bus-port 0
cluster-announce-port 0
cluster-migration-barrier 1
cluster-node-timeout 15000
cluster-replica-no-failover no
cluster-replica-validity-factor 10
cluster-require-full-coverage yes
cluster-slave-no-failover no
cluster-slave-validity-factor 10
databases 16
dbfilename dump.rdb
dir {current working directory}
dynamic-hz yes
hash-max-ziplist-entries 512
hash-max-ziplist-value 64
hll-sparse-max-bytes 3000
hz 10
latency-monitor-threshold 0
lazyfree-lazy-eviction no
lazyfree-lazy-expire no
lazyfree-lazy-server-del no
lfu-decay-time 1
lfu-log-factor 10
list-compress-depth 0
list-max-ziplist-size -2
loglevel notice
lua-time-limit 5000
maxclients 10000
maxmemory 0
maxmemory-policy noeviction
maxmemory-samples 5
min-replicas-max-lag 10
min-replicas-to-write 0
min-slaves-max-lag 10
min-slaves-to-write 0
no-appendfsync-on-rewrite no
port 6379
protected-mode yes
proto-max-bulk-len 512mb
rdbchecksum yes
rdbcompression yes
rdb-save-incremental-fsync yes
repl-backlog-size 1mb
repl-backlog-ttl 3600
repl-disable-tcp-nodelay no
repl-diskless-sync no
repl-diskless-sync-delay 5
replica-announce-port 0
replica-ignore-maxmemory yes
replica-lazy-flush no
replica-priority 100
replica-read-only yes
replica-serve-stale-data yes
repl-ping-replica-period 10
repl-ping-slave-period 10
repl-timeout 60
save 900 1
save 300 10
save 60 10000
set-max-intset-entries 512
slave-announce-port 0
slave-ignore-maxmemory yes
slave-lazy-flush no
slave-priority 100
slave-read-only yes
slave-serve-stale-data yes
slowlog-log-slower-than 10000
slowlog-max-len 128
stop-writes-on-bgsave-error yes
stream-node-max-bytes 4096
stream-node-max-entries 100
tcp-backlog 511
tcp-keepalive 300
timeout 0
watchdog-period 0
winlog-level notice
zset-max-ziplist-entries 128
zset-max-ziplist-value 64
```

--------------------------------

### OpenSSL Configuration for Certificates

Source: https://docs.memurai.com/en/config-tls

These are OpenSSL configuration sections used to define certificate usage. `[ server_cert ]` is for server certificates, specifying key usage and type, while `[ client_cert ]` is for client certificates with similar specifications. These files are referenced during certificate generation.

```openssl
[ server_cert ]
keyUsage = digitalSignature, keyEncipherment
nsCertType = server

[ client_cert ]
keyUsage = digitalSignature, keyEncipherment
nsCertType = client
```

--------------------------------

### Show active indexes

Source: https://docs.memurai.com/en/commands

The MSQL.SHOW command lists all active indexes in the system. An optional argument 'WITH COLUMNS' can be provided to also display the columns associated with each index.

```MSQL
MSQL.SHOW
```

```MSQL
MSQL.SHOW WITH COLUMNS
```

--------------------------------

### Configure Windows Event Log Level (winlog-level)

Source: https://docs.memurai.com/en/config-file

Specifies the verbosity level for the Windows Event Log. This setting is specific to the Event Log and does not affect log file output. Options range from 'debug' (most verbose) to 'off' (no logging). The default production level is typically 'notice'.

```memurai-config
winlog-level notice
```

--------------------------------

### Describe index information

Source: https://docs.memurai.com/en/commands

The MSQL.DESCRIBE command is used to retrieve the columns and their data types for a specified index.

```MSQL
MSQL.DESCRIBE   mymovies
```

--------------------------------

### MSQL.QUERY Data Querying

Source: https://docs.memurai.com/en/commands

Executes the specified query against your current indexes, enabling SQL-like queries on Memurai data.

```APIDOC
## MSQL.QUERY

### Description
Executes the specified query against your current indexes, enabling you to run SQL-like queries and return the information that you need. The `MSQL.QUERY` command is very useful overall for searching and running queries on the hash entries across your Memurai data stores.

### Method
MSQL.QUERY

### Endpoint
N/A (This is a command, not an HTTP endpoint)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Syntax
```
MSQL.QUERY [QUERY TEXT]
```

- `[QUERY TEXT]`: string - The SQL-like query to execute against the indexes.

### Request Example
```
MSQL.QUERY SELECT name, dob FROM employee WHERE id = "employee:002"
```

### Response
#### Success Response (200)
Returns the results of the executed query.

#### Response Example
```json
{
  "results": [
    {
      "name": "John Smith",
      "dob": "2000-01-01"
    }
  ]
}
```
```

--------------------------------

### Configure Memurai File Logging Path

Source: https://docs.memurai.com/en/config-logging

Illustrates various valid ways to specify the log file path for Memurai. This includes using Unix-style path delimiters, absolute paths with quotes for spaces, and UNC paths for network shares.

```config
logfile memurai.log
```

```config
logfile "log/memurai.log" # Unix-style path delimiter
```

```config
logfile 'C:\memurai data\memurai.log' # Absolute path single/double quotes can be used
```

```config
logfile "\\fileshare\memurai\memurai.log" # UNC folder
```

--------------------------------

### Generate Server Certificate with OpenSSL

Source: https://docs.memurai.com/en/config-tls

This command generates a private key for the Memurai server and then creates a certificate signing request (CSR). The CSR is then signed by the CA key to produce the server certificate. It specifies server-specific extensions from `openssl.cnf` and is valid for 365 days. This certificate and its corresponding key will be used by the Memurai server for TLS.

```bash
openssl genrsa -out tls/server.key 2048
openssl req -new -sha256 -subj "/O=Memurai Test/CN=Server-only" \
        -key tls/server.key | openssl x509 -req -sha256 -CA tls/ca.crt \
        -CAkey tls/ca.key -CAserial tls/ca.txt -CAcreateserial -days 365 \
        -extfile tls/openssl.cnf -extensions server_cert -out tls/server.crt
```

--------------------------------

### Query Index Data with MSQL.QUERY

Source: https://docs.memurai.com/en/commands

The MSQL.QUERY command executes SQL-like queries against existing index tables. This command is highly effective for searching and retrieving specific information from hash entries stored in Memurai data stores.

```memurai-sql
MSQL.QUERY [QUERY TEXT]

```

--------------------------------

### Enable TLS for Memurai Replication

Source: https://docs.memurai.com/en/config-tls

Configures Memurai replicas to use TLS for outgoing connections to the master server. The `tls-replication yes` directive ensures secure communication between master and replicas, inheriting TLS settings from the main configuration.

```ini
tls-replication yes
```

--------------------------------

### Generate CA Key and Certificate with OpenSSL

Source: https://docs.memurai.com/en/config-tls

This sequence of OpenSSL commands generates a Certificate Authority (CA) key and a self-signed CA certificate. The `genrsa` command creates a 4096-bit RSA private key for the CA, and the `req` command generates a new X.509 certificate signed by this key, valid for 10 years. This CA will be used to sign server and client certificates.

```bash
openssl genrsa -out tls/ca.key 4096
openssl req -x509 -new -nodes -sha256 -key tls/ca.key -days 3650 \
            -subj '/O=Memurai Test/CN=Certificate Authority' -out tls/ca.crt
```

--------------------------------

### Generate Client Certificate with OpenSSL

Source: https://docs.memurai.com/en/config-tls

This command generates a private key for a Memurai client and creates a certificate signing request (CSR). The CSR is signed by the CA key to produce the client certificate, which is valid for 365 days. It includes client-specific extensions defined in `openssl.cnf`. This certificate and its key can be used by clients to authenticate with the Memurai server.

```bash
openssl genrsa -out tls/client.key 2048
openssl req -new -sha256 -subj "/O=Memurai Test/CN=Client-only" \
            -key tls/client.key | openssl x509 -req -sha256 \
            -CA tls/ca.crt -CAkey tls/ca.key -CAserial tls/ca.txt \
            -CAcreateserial -days 365 -extfile tls/openssl.cnf \
            -extensions client_cert -out tls/client.crt
```

--------------------------------

### Check and Fix Memurai RDB Files using memurai-check-rdb.exe

Source: https://docs.memurai.com/en/check-aof-rdb

The `memurai-check-rdb.exe` command-line utility is designed to examine Redis Database (RDB) persistence files utilized by Memurai. It allows users to check for and attempt to resolve integrity problems within these files. The tool is provided as a standalone executable for managing RDB file health.

```bash
memurai-check-rdb.exe <filename> # Check specified file and try to fix any issues
```

--------------------------------

### Modules API Compatibility Exceptions

Source: https://docs.memurai.com/en/reference-api-modules

Details known exceptions to the Redis Modules API compatibility for Memurai versions.

```APIDOC
## Modules API Compatibility Exceptions

### Description
This section details known exceptions to the Redis Modules API compatibility in Memurai. Memurai aims for compatibility with the Redis 7 Modules API, but certain modules may require recompilation or porting for Windows. Due to licensing, Memurai does not offer or support ported modules. This list is updated to document known exceptions.

### Method
N/A (Informational)

### Endpoint
N/A (Informational)

### Unsupported APIs in Memurai 2.0.0 (Introduced in Redis 5.0.6)

- `RedisModuleTypeAuxLoadFunc aux_load;`
- `RedisModuleTypeAuxSaveFunc aux_save;`
- `int aux_save_triggers;`

### Related Modules

- **Copy**: Specific information regarding the 'Copy' functionality in relation to module compatibility is not detailed here but is noted as a separate item.
- **APILua Scripting API**: Refer to the APILua Scripting API documentation for details on Lua scripting compatibility.
```

--------------------------------

### Enable TLS for Memurai Cluster

Source: https://docs.memurai.com/en/config-tls

Enables TLS for the cluster bus and cross-node connections in Memurai Cluster mode. The `tls-cluster yes` directive ensures secure communication between nodes within the cluster.

```ini
tls-cluster yes
```

--------------------------------

### Add OpenSSL to PowerShell Path

Source: https://docs.memurai.com/en/config-tls

This PowerShell command adds an alias for the openssl executable to your PowerShell profile. This allows you to use the 'openssl' command directly in any PowerShell session without needing to specify the full path. Ensure the provided path to 'openssl.exe' is correct for your system.

```powershell
Add-Content -Path $PROFILE -Value \
            'Set-Alias -Name openssl -Value "C:\Program Files\Git\usr\bin\openssl.exe"'
```
Tokens:
Raw