neo4j script file format - is there any? - neo4j

I would like to predefine some graph data for neo4j and be able to load it, maybe via a console tool. I'd like it to be precisely the same as MySQL CLI and .sql files. Does anyone know if there exists a file format like .neo or .neo4j? I couldn't find such thing in the docs...

We usually do .cql or .cypher for script files. You can pipe it to the shell to run it, like so:
./neo4j-shell -c < MY_FILE.cypher
Michael Hunger was doing some great work on this feature, also, just recently. He got performance up and noise down from the console. I hope it gets into 1.9 release.

From https://groups.google.com/forum/#!topic/opencypher/PO5EnspBLs0
1:
"Sorry for the late reply, but we just wanted to inform you that the official recommendation is to use .cypher.
We'll be formalising this in the style guide soon."
2:
"In training run by Neo4j, we've historically used .cyp. I believe the preference is to use .cypher, and .cyp when an extension of 3 chars is required."
3:
"Note: '.cql' is already used for Cassandra - https://cassandra.apache.org/doc/cql/CQL.html"
From the above extracts:
1st preference is .cypher
2nd preference is .cyp (1st 3 characters of cypher)
Don't use .cql
More:
If you need a color coding in notepad++, download the xml given at https://gist.github.com/nicolewhite/b0344ea475852c8c9571 , import it via menu Language > User Defined Language > Import > Restart the Notepad++, open a file with .cypher that has some cyper query language)
Sample cypher is below:
MATCH (:Person {name: "Ann"}) -[:FB_FRIENDS]-> Create (:Person {name: "Dan"})
Hope that helps someone.

Using neo4j-client as the CLI for Neo4j allows for easy evaluation of scripts. There are several ways to work with a script containing multiple cypher commands:
You can pipe the script in via standard input, e.g.:
neo4j-client -u neo4j -P localhost < my_script.cyp
You can use the command line option --source or -i, e.g.:
neo4j-client -u neo4j -P -i my_script.cyp localhost
You can start an interactive shell, and then source the script:
$ neo4j-client localhost
Username: neo4j
Password: *****
neo4j-client 1.2.1.
Enter `:help` for usage hints.
Connected to 'neo4j://neo4j#localhost:7687'
neo4j>
neo4j> :source my_script.cyp
The extension .cyp is most commonly used for scripts.

Related

Running CQL file in Neo4j

I have a CQL file called Novis.cql. Its somewhere random on my harddrive, but I want to run it in Neo4J to create my graph (it contains 500+ lines of code).
Where do I have to place it? And what command do I have to run nowadays to get it working? I've read and searched for answers, but some of the commands like Neo4jshell dont seem to work any longer...
Any help would be very appreciated!
The cypher-shell tool has been available for a while (starting with version 3.0, if not earlier), and you can use it to execute a Cypher query from a file that can be anywhere in your file system.
For example (on a linux/unix system), a command line like this will work (if you are in the neo4j home directory):
cat /my/full/path/my_code.cql | bin/cypher-shell -u neo4j -p secret
In neo4j 4.0 a new -f option was added to make it simpler:
bin/cypher-shell -u neo4j -p secret -f /my/full/path/my_code.cql

How to Load Cypher File into Neo4j

I have generated a cypher file and want to load it into neo4j.
The only relevant documentation I could find was about loading csv's.
I also tried the shell but it seems to have no effect
cypher-shell.bat -uneo4j -pne04j < db.cql
Copy paste into localhost:7474/browser makes the browser unresponsive.
In the current Neo4j version you can use Cypher Shell to achieve your goal.
From the docs, Invoke Cypher Shell with a Cypher script from the command line:
$ cat db.cql | bin/cypher-shell -u yourneo4juser -p yourpassword
Note that this example is based in a Linux instalation. If you are using Neo4j with Windows, you will need to adjust this command to your needs.
Not sure when this has been added but in the current version (4.4) an alternative way to load a cypher file to NEO4J (GUI) is by dragging and dropping the cypher file over the web browser, which then offers two options, either to add it to the favorites or to paste it in the editor.

Possible to specify a file of cypher commands with neo4j-shell-tools?

I want to use the neo4j-shell-tools https://github.com/jexp/neo4j-shell-tools because my desired output is a CSV file. With a single Cypher command, this works great, e.g.,
neo4j restart
neo4j-shell
import-cypher -o out.csv match (p) return count(p) as count
However, I actually have a large number of cypher commands saved in a .cql file that I'd like to run. So long as I don't want to export as a CSV file, I can do so via
neo4j-shell -file neatStuff.cql
However, I haven't been able to find a way to combine these, that is, using import-cypher to export the results of a file's worth of Cypher commands.
Does anyone know if this is possible and, if so, how it would be best done? Thank you.
If using multiple commands is not an issue, you can use a pipe. This works on both Unix-based and Windows systems.
echo 'import-cypher -o out.csv match (p) return count(p) as count' | bin/neo4j-shell
neo4j-shell -file neatStuff.cql
Note: the openCypher style guide recommends the .cypher extensions. If you would like to keep is short, use .cyp as .cql is the extensions for the Cassandra Query Language.
Update: as pointed out by the OP in the comments, the latest version of APOC provides apoc.export.csv.* methods.

"import-cypher" neo4j exporting to csv without quotes

My neo4j version is 2.1 and I am using neo4j-shell-tools_2.1.zip in order to export data to a csv file in neo4j shell.
In the csv output, I would like to data without quotes and the following command does not seem to work. Is the command only for 2.2 version?
import-cypher -d , -o test.csv match (p:Product)-[s:RELATED_TO]-(q:Product) return toInt(p.Id), toInt(q.Id) limit 3
The output of the above command in the test.csv looks like below.
"toInt(p.Id)","toInt(q.Id)"
"11505932","5944562"
"9594143","5944562"
"9594203","5944562"
How can I output without quotes? Is it even possible?
Thank you.
Please raise an issue on GitHub or send a PR.
It would make sense to not use quotes for non-strings.

How to execute Cypher in a file?

I am working on windows. I have created a text file of Cypher query using notepad. How can I run the query in the file using Neo4jShell or Neo4j web interface console.
On Debian/Ubuntu or any *nix installations, use the following from terminal:
$ neo4j-shell -c < path-to-cypher-query-file.cql
Note that each cypher query in the file must end in a semicolon and must be separated by a blank line from the other query. Also, the .cql ending (file format) is not mandatory.
Just add -file as a parameter when starting the console.
On windows, it would look like this :
Neo4jShell.bat -file path/to/cql/file
Or you could also print the result into a new file
Neo4jShell.bat -file path/to/cql/file > path/to/output/file
I'm also sure there is a way to do it from within the shell and not at startup, as it was once demonstrated to me by Stefan Armbruster but for the love of god, I can't remember how he did it. But this approach works as well.
$ neo4j-shell -file query.cql
or using cypher-shell
$ cat query.cql | cypher-shell
The neo4jShell.bat file has been removed since this question was asked. The new approach to execute cypher files is to use the web application called LazyWebCypher .
With Neo4j web interface I just do copy&paste.
On the console I sometimes use curl to talk to Neo4j's REST interface. That allows me to use the same queries (with references to separate parameters) that I have in my application.
You have to wrap the query in your file into a json object for that.
data.json:
{
"query":"match (u:User) where u.username={username} return u",
"params":{"username":"trenkerbe"}
}
command:
curl -i -X POST -H "Content-Type: application/json" -d #data.json http://localhost:7474/db/data/cypher
./bin/neo4j-shell -path ../data/databases/ -c < commands.cql
on Neo4j 3.2.1

Resources