Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check if any flag is not documented in memgraph #642

Closed
Josipmrden opened this issue Apr 2, 2024 · 2 comments · Fixed by #721
Closed

Check if any flag is not documented in memgraph #642

Josipmrden opened this issue Apr 2, 2024 · 2 comments · Fixed by #721
Assignees
Labels
priority: medium (missing info) An additional information can be helpful or interesting, but the absence is not disruptive status: draft PR is still a draft

Comments

@Josipmrden
Copy link
Contributor

run memgraph with --help and verify if any flag is missing from the documentation page. All the --help flags that are listed should be providable by the user

@Josipmrden Josipmrden added the priority: medium (missing info) An additional information can be helpful or interesting, but the absence is not disruptive label Apr 2, 2024
@kgolubic
Copy link
Collaborator

Output of memgraph --help:

[2024-04-16 15:42:43.632] [warning] storage_parallel_index_recovery flag is deprecated. Check storage_mode_parallel_schema_recovery for more details.
[2024-04-16 15:42:43.633] [warning] auth_module_create_missing_role flag is deprecated. It not possible to create roles through the module anymore.
[2024-04-16 15:42:43.633] [warning] auth_module_create_missing_user flag is deprecated. It not possible to create users through the module anymore.
[2024-04-16 15:42:43.633] [warning] auth_module_manage_roles flag is deprecated. It not possible to create roles through the module anymore.
[2024-04-16 15:42:43.633] [warning] storage_parallel_index_recovery flag is deprecated. Check storage_mode_parallel_schema_recovery for more details.
memgraph: Memgraph database server
    --allow-load-csv (Controls whether LOAD CSV clause is allowed in queries.)
        type: bool default: true
    --audit-buffer-flush-interval-ms (Interval (in milliseconds) used for
        flushing the audit log buffer.) type: int32 default: 200
    --audit-buffer-size (Maximum number of items in the audit log buffer.)
        type: int32 default: 100000
    --audit-enabled (Set to true to enable audit logging.) type: bool
        default: false
    --auth-module-executable (Absolute path to the auth module executable that
        should be used.) type: string default: ""
    --auth-module-timeout-ms (Timeout (in milliseconds) used when waiting for a
        response from the auth module.) type: int32 default: 10000
    --auth-password-permit-null (Set to false to disable null passwords.)
        type: bool default: true
    --auth-password-strength-regex (The regular expression that should be used
        to match the entire entered password to ensure its strength.)
        type: string default: ".+"
    --auth-user-or-role-name-regex (Set to the regular expression that each
        user or role name must fulfill.) type: string
        default: "[a-zA-Z0-9_.+-@]+"
    --bolt-address (IP address on which the Bolt server should listen.)
        type: string default: "0.0.0.0"
    --bolt-cert-file (Certificate file which should be used for the Bolt
        server.) type: string default: ""
    --bolt-key-file (Key file which should be used for the Bolt server.)
        type: string default: ""
    --bolt-num-workers (Number of workers used by the Bolt server. By default,
        this will be the number of processing units available on the machine.)
        type: int32 default: 2
    --bolt-port (Port on which the Bolt server should listen.) type: int32
        default: 7687
    --bolt-server-name-for-init (Server name which the database should send to
        the client in the Bolt INIT message.) type: string
        default: "Neo4j/v5.11.0 compatible graph database server - Memgraph"
    --bolt-session-inactivity-timeout (Time in seconds after which inactive
        Bolt sessions will be closed.) type: int32 default: 1800
    --cartesian-product-enabled (Enable cartesian product expansion.)
        type: bool default: true
    --coordinator-id (Unique ID of the raft server.) type: uint32 default: 0
    --coordinator-port (Port on which raft servers will be started.)
        type: int32 default: 0
    --data-directory (Path to directory in which to save all permanent data.)
        type: string default: "mg_data" currently: "/var/lib/memgraph"
    --data-recovery-on-startup (Controls whether the database recovers
        persisted data on startup.) type: bool default: false
    --delta-chain-cache-threshold (The threshold for when to cache long delta
        chains. This is used for heavy read + write workloads where repeated
        processing of delta chains can become costly.) type: uint64
        default: 128
    --experimental-enabled (Experimental features to be used, comma-separated.
        Options [system-replication, text-search, high-availability])
        type: string default: ""
    --flag-file (load flags from file) type: string default: ""
        currently: "/etc/memgraph/memgraph.conf"
    --help (show help on all flags [tip: all flags can have two dashes])
        type: bool default: false currently: true
    --help-xml (produce an xml version of help) type: bool default: false
    --init-data-file (Path to cypherl file that is used for creating data after
        server starts.) type: string default: ""
    --init-file (Path to cypherl file that is used for configuring users and
        database schema before server starts.) type: string default: ""
    --instance-down-timeout-sec (Time duration after which an instance is
        considered down.) type: uint32 default: 5
    --instance-get-uuid-frequency-sec (The time duration between two instance
        uuid checks.) type: uint32 default: 10
    --instance-health-check-frequency-sec (The time duration between two health
        checks/pings.) type: uint32 default: 1
    --isolation-level (Default isolation level used for the transactions.
        Allowed values: SNAPSHOT_ISOLATION, READ_COMMITTED, READ_UNCOMMITTED)
        type: string default: "SNAPSHOT_ISOLATION"
        currently: "SNAPSHOT_ISOLATION"
    --kafka-bootstrap-servers (List of default Kafka brokers as a comma
        separated list of broker host or host:port.) type: string default: ""
    --log-file (Path to where the log should be stored.) type: string
        default: "" currently: "/var/log/memgraph/memgraph.log"
    --log-level (Minimum log level. Allowed values: TRACE, DEBUG, INFO,
        WARNING, ERROR, CRITICAL) type: string default: "WARNING"
        currently: "WARNING"
    --management-port (Port on which coordinator servers will be started.)
        type: int32 default: 0
    --memory-limit (Total memory limit in MiB. Set to 0 to use the default
        values which are 100% of the phyisical memory if the swap is enabled
        and 90% of the physical memory otherwise.) type: uint64 default: 0
        currently: 0
    --memory-warning-threshold (Memory warning threshold, in MB. If Memgraph
        detects there is less available RAM it will log a warning. Set to 0 to
        disable.) type: uint64 default: 1024
    --metrics-address (IP address on which the Memgraph server for exposing
        metrics should listen.) type: string default: "0.0.0.0"
    --metrics-port (Port on which the Memgraph server for exposing metrics
        should listen.) type: int32 default: 9091
    --monitoring-address (IP address on which the websocket server for Memgraph
        monitoring should listen.) type: string default: "0.0.0.0"
    --monitoring-port (Port on which the websocket server for Memgraph
        monitoring should listen.) type: int32 default: 7444
    --password-encryption-algorithm (The password encryption algorithm used for
        authentication.) type: string default: "bcrypt"
    --pulsar-service-url (Default URL used while connecting to Pulsar brokers.)
        type: string default: ""
    --query-callable-mappings-path (The path to mappings that describes aliases
        to callables in cypher queries in the form of key-value pairs in a json
        file. With this option query module procedures that do not exist in
        memgraph can be mapped to ones that exist.) type: string default: ""
        currently: "/etc/memgraph/apoc_compatibility_mappings.json"
    --query-cost-planner (Use the cost-estimating query planner.) type: bool
        default: true
    --query-execution-timeout-sec (Maximum allowed query execution time.
        Queries exceeding this limit will be aborted. Value of 0 means no
        limit.) type: double default: 600
    --query-max-plans (Maximum number of generated plans for a query.)
        type: uint64 default: 1000
    --query-modules-directory (Directory where modules with custom query
        procedures are stored. NOTE: Multiple comma-separated directories can
        be defined.) type: string default: ""
        currently: "/usr/lib/memgraph/query_modules"
    --query-plan-cache-max-size (Maximum number of query plans to cache.)
        type: int32 default: 1000
    --query-vertex-count-to-expand-existing (Maximum count of indexed vertices
        which provoke indexed lookup and then expand to existing, instead of a
        regular expand. Default is 10, to turn off use -1.) type: int64
        default: 10
    --replication-replica-check-frequency-sec (The time duration between two
        replica checks/pings. If < 1, replicas will NOT be checked at all.
        NOTE: The MAIN instance allocates a new thread for each REPLICA.)
        type: uint64 default: 1
    --replication-restore-state-on-startup (Restore replication state on
        startup, e.g. recover replica) type: bool default: false
    --storage-automatic-edge-type-index-creation-enabled (Controls whether
        edge-type indexes on relationships should be created automatically.)
        type: bool default: false currently: false
    --storage-automatic-label-index-creation-enabled (Controls whether label
        indexes on vertices should be created automatically.) type: bool
        default: false currently: false
    --storage-delta-on-identical-property-update (Controls whether updating a
        property with the same value should create a delta object.) type: bool
        default: true
    --storage-enable-edges-metadata (Controls whether additional metadata
        should be stored about the edges in order to do faster traversals on
        certain queries.) type: bool default: false currently: false
    --storage-enable-schema-metadata (Controls whether metadata should be
        collected about the resident labels and edge types.) type: bool
        default: false currently: false
    --storage-gc-cycle-sec (Storage garbage collector interval (in seconds).)
        type: uint64 default: 30
    --storage-items-per-batch (The number of edges and vertices stored in a
        batch in a snapshot file.) type: uint64 default: 1000000
    --storage-mode (Default storage mode Memgraph uses. Allowed values:
        IN_MEMORY_TRANSACTIONAL, IN_MEMORY_ANALYTICAL, ON_DISK_TRANSACTIONAL)
        type: string default: "IN_MEMORY_TRANSACTIONAL"
        currently: "IN_MEMORY_TRANSACTIONAL"
    --storage-parallel-index-recovery (Controls whether the index creation can
        be done in a multithreaded fashion.) type: bool default: false
        currently: false
    --storage-parallel-schema-recovery (Controls whether the indices and
        constraints creation can be done in a multithreaded fashion.)
        type: bool default: false currently: false
    --storage-properties-on-edges (Controls whether edges have properties.)
        type: bool default: false currently: true
    --storage-python-gc-cycle-sec (Storage python full garbage collection
        interval (in seconds).) type: uint64 default: 180
    --storage-recovery-thread-count (The number of threads used to recover
        persisted data from disk.) type: uint64 default: 8
    --storage-snapshot-interval-sec (Storage snapshot creation interval (in
        seconds). Set to 0 to disable periodic snapshot creation.) type: uint64
        default: 0 currently: 300
    --storage-snapshot-on-exit (Controls whether the storage creates another
        snapshot on exit.) type: bool default: false currently: true
    --storage-snapshot-retention-count (The number of snapshots that should
        always be kept.) type: uint64 default: 3 currently: 3
    --storage-wal-enabled (Controls whether the storage uses
        write-ahead-logging. To enable WAL periodic snapshots must be enabled.)
        type: bool default: false currently: true
    --storage-wal-file-flush-every-n-tx (Issue a 'fsync' call after this amount
        of transactions are written to the WAL file. Set to 1 for fully
        synchronous operation.) type: uint64 default: 100000
    --storage-wal-file-size-kib (Minimum file size of each WAL file.)
        type: uint64 default: 20480
    --stream-transaction-conflict-retries (Number of times to retry when a
        stream transformation fails to commit because of conflicting
        transactions) type: uint32 default: 30
    --stream-transaction-retry-interval (Retry interval in milliseconds when a
        stream transformation fails to commit because of conflicting
        transactions) type: uint32 default: 500
    --telemetry-enabled (Set to true to enable telemetry. We collect
        information about the running system (CPU and memory information) and
        information about the database runtime (vertex and edge counts and
        resource usage) to allow for easier improvement of the product.)
        type: bool default: false currently: true
    --version (show version and build info and exit) type: bool default: false

@kgolubic
Copy link
Collaborator

kgolubic commented Apr 24, 2024

Undocumented flags are:

--help (show help on all flags [tip: all flags can have two dashes])
        type: bool default: false currently: true
--help-xml (produce an xml version of help) type: bool default: false
--version (show version and build info and exit) type: bool default: false

@kgolubic kgolubic added the status: draft PR is still a draft label Apr 24, 2024
@kgolubic kgolubic linked a pull request Apr 24, 2024 that will close this issue
10 tasks
@kgolubic kgolubic mentioned this issue Apr 24, 2024
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: medium (missing info) An additional information can be helpful or interesting, but the absence is not disruptive status: draft PR is still a draft
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants