Difference between revisions of "SurrealDB"

Latest revision as of 14:24, 20 May 2024

Description

SurrealDB offers a dynamic and adaptable platform for business. With an integrated suite of cutting-edge database solutions, tools, and services, SurrealDB empowers your workforce to discover innovative answers using products meticulously crafted to meet their requirements.

Environment Modules

Run module spider surrealdb to find out what environment modules are available for this application.

System Variables

HPC_SURREALDB_DIR - installation directory
HPC_SURREALDB_BIN - executable directory

Additional Information

Once installed, you can run the SurrealDB command-line tool by using the surreal command. To see if the installation was successful, you can just run the following command in your terminal.

surreal help

The result should look similar to the output below, confirming that the SurrealDB command-line tool was installed successfully.

Expand to view.

 .d8888b.                                             888 8888888b.  888888b.
d88P  Y88b                                            888 888  'Y88b 888  '88b
Y88b.                                                 888 888    888 888  .88P
 'Y888b.   888  888 888d888 888d888  .d88b.   8888b.  888 888    888 8888888K.
    'Y88b. 888  888 888P'   888P'   d8P  Y8b     '88b 888 888    888 888  'Y88b
      '888 888  888 888     888     88888888 .d888888 888 888    888 888    888
Y88b  d88P Y88b 888 888     888     Y8b.     888  888 888 888  .d88P 888   d88P
 'Y8888P'   'Y88888 888     888      'Y8888  'Y888888 888 8888888P'  8888888P'


To get started using SurrealDB, and for guides on connecting to and building applications
on top of SurrealDB, check out the SurrealDB documentation (https://surrealdb.com/docs).

If you have questions or ideas, join the SurrealDB community (https://surrealdb.com/community).

If you find a bug, submit an issue on GitHub (https://github.com/surrealdb/surrealdb/issues).

We would love it if you could star the repository (https://github.com/surrealdb/surrealdb).

----------

Usage: surreal [OPTIONS] <COMMAND>

Commands:
  start     Start the database server
  import    Import a SurrealQL script into an existing database
  export    Export an existing database as a SurrealQL script
  version   Output the command-line tool and remote server version information
  upgrade   Upgrade to the latest stable version
  sql       Start an SQL REPL in your terminal with pipe support
  ml        Manage SurrealML models within an existing database
  is-ready  Check if the SurrealDB server is ready to accept connections [aliases: isready]
  validate  Validate SurrealQL query files
  help      Print this message or the help of the given subcommand(s)

Options:
      --online-version-check  Whether to allow web check for client version upgrades at start [env: SURREAL_ONLINE_VERSION_CHECK=]
  -h, --help                  Print help
  -V, --version               Print version

@@ Line 1: / Line 1: @@
 [[Category:Software]]
 {|<!--CONFIGURATION: REQUIRED-->
-|{{#vardefine:app|SurrealDB}}
+|{{#vardefine:app|surrealdb}}
 |{{#vardefine:url|https://surrealdb.com/}}
 <!--CONFIGURATION: OPTIONAL (|1}} means it's ON)-->
@@ Line 25: / Line 25: @@
 ==System Variables==
 * HPC_{{uc:{{#var:app}}}}_DIR - installation directory
+* HPC_{{uc:{{#var:app}}}}_BIN - executable directory
 <!--Configuration-->
 {{#if: {{#var: conf}}|==Configuration==
 See the [[{{PAGENAME}}_Configuration]] page for {{#var: app}} configuration details.
 |}}
 <!--Run-->
-{{#if: {{#var: exe}}|==Additional Information==
+==Additional Information==
-Once installed, you can run the SurrealDB command-line tool by using the surreal command. To check whether the install was successful run the following command in your terminal.
+Once installed, you can run the SurrealDB command-line tool by using the <code>surreal</code> command. To see if the installation was successful, you can just run the following command in your terminal.
-surreal help
+ surreal help
 The result should look similar to the output below, confirming that the SurrealDB command-line tool was installed successfully.
+<div class="mw-collapsible mw-collapsed" style="width:70%; padding: 5px; border: 1px solid gray;">
+''Expand to view.''
+<div class="mw-collapsible-content" style="padding: 5px;">
+<pre>
   .d8888b.                                             888 8888888b.  888888b.
 d88P  Y88b                                            888 888  'Y88b 888  '88b
@@ Line 77: / Line 83: @@
    -h, --help                  Print help
    -V, --version               Print version
+</pre>
+</div>
+</div>
-|}}
 <!--Job Scripts-->
 {{#if: {{#var: job}}|==Job Script Examples==
 See the [[{{PAGENAME}}_Job_Scripts]] page for {{#var: app}} Job script examples.
 |}}
 <!--Policy-->
 {{#if: {{#var: policy}}|==Usage Policy==
@@ Line 90: / Line 98: @@
 |}}
 <!--Performance-->
 {{#if: {{#var: testing}}|==Performance==