OrientDB Tools

Command-line shell scripts for working with OrientDB databases.

Installation

1. Install Composer (if not yet installed).
2. Run composer install in the project's directory.
3. Modify env-config.json to suit your environment's configuration. - The environment variable ENV_NAME determines which environment you are in.
   • Valid values are those specified as keys in env-config.json. - Note: do NOT save the modified file back to the git repo.
4. Run any tool without arguments for more information about the tool. - Ex. ./orientdb-import.php

Which tools are available?

Currently, only one tool is available.

orientdb-import

Allows importing data in CSV format into an OrientDB database.

Syntax

orientdb-import.php [--env local|intranet|staging|production] [--clear] [--limit N] [--set {json}] database class input-file.csv

CSV format

• 1st line must define field names.
• Other lines define one record per line.
• Fields should be delimited by commas.
• String fields should be surrounded by double quotes.
• If a field's value seems to be a valid number, it will be typecasted to a float.
• If a field's value is "true" or "false", it will be typecasted to a boolean.
• If you need to import numbers or booleans as strings, enclose them in double qoutes.

Command-line options

--env

Force a specific configuration environment. If not specified, the environment name will be determined by the ENV_NAME environmental variable. If no variable is defined, the name defaults to local.

--clear

When specified, this option causes all existing records of the target class to be erased before the import begins.

--limit

Limit the maximum number of records to be imported. If not specified, all records will be imported.

--set

Allows merging constant data into each record being imported. The option's argument should be encoded as JSON. You should escape spaces using \, otherwise a space will prematurely end the option's argument at that point.

Tests

A very basic test is provided on the tests folder. Before running the test, create a testdb database and a testclass class in it. Then, run ./test.sh on the command-line.

License

MIT

The MIT License (MIT)

Copyright (c) 2014 Impactwave Lda

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.