Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/graphaware/neo4j-warmup

Simple library that warms up Neo4j caches with a single REST call
https://github.com/graphaware/neo4j-warmup

Last synced: 3 months ago
JSON representation

Simple library that warms up Neo4j caches with a single REST call

Host: GitHub
URL: https://github.com/graphaware/neo4j-warmup
Owner: graphaware
Archived: true
Created: 2014-08-23T18:55:44.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2016-07-05T11:25:31.000Z (over 8 years ago)
Last Synced: 2024-08-02T07:10:39.795Z (6 months ago)
Language: Java
Size: 68.4 KB
Stars: 10
Watchers: 26
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

awesome-neo4j - GraphAware Neo4j Warmup - Simple library that warms up Neo4j caches with a single REST call. (REST API / Other)

README

GraphAware Neo4j Warmup - RETIRED
=================================

Warmup Has Been Retired
-----------------------

As of July 5th 2016, this module is retiring. This means it will no longer be maintained and released together with
new versions of the GraphAware Framework and Neo4j. The last compatible Neo4j version is 3.0.3.

If you're interested in its functionality, please use [APOC](https://github.com/neo4j-contrib/neo4j-apoc-procedures#warmup) instead. Unlike many other GraphAware modules, nobody is
using Warmup in production, to the best of our knowledge.

This repository will remain public. Please get in touch if you've been using Warmup and APOC isn't good enough for you.

Introduction
------------

[![Build Status](https://travis-ci.org/graphaware/neo4j-warmup.png)](https://travis-ci.org/graphaware/neo4j-warmup) | Downloads | Latest Release: 3.0.3.39.5

GraphAware WarmUp is a simple piece of code that warms up Neo4j caches using a single API call by accessing the entire
graph using all available processors.

Getting the Software
--------------------

### Server Mode

When using Neo4j in the standalone server mode,
you will need the GraphAware Neo4j Framework and GraphAware Neo4j WarmUp .jar files (both of which you can download here) dropped
into the `plugins` directory of your Neo4j installation. After Neo4j restart, you will be able to use the REST API and stored procedures.

### Embedded Mode / Java Development

Java developers that use Neo4j in embedded mode
and those developing Neo4j server plugins,
unmanaged extensions,
GraphAware Runtime Modules, or Spring MVC Controllers can include use WarmUp as a dependency for their Java project.

#### Releases

Releases are synced to Maven Central repository. When using Maven for dependency management, include the following dependency in your pom.xml.

...

com.graphaware.neo4j
warmup
3.0.3.39.5

...

#### Note on Versioning Scheme

The version number has two parts. The first four numbers indicate compatibility with Neo4j GraphAware Framework.
The last number is the version of the WarmUp library. For example, version 2.1.3.15.1 is version 1 of WarmUp
compatible with GraphAware Neo4j Framework 2.1.3.15.

Using GraphAware WarmUp
-----------------------

In server mode, execute the `CALL ga.warmup.run()` Cypher query or issue a GET request to `http://your-server-address:7474/graphaware/warmup/` to warm up the caches.
In Java, use the `warmUp` method on the `WarmUp` class.

License
-------

GraphAware is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License
as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program.
If not, see .