Grails

https://grails.apache.org/docs/latest
Admin
Grails is a powerful, open-source web development framework built on Groovy and Java that simplifies...
Tokens:2,978,209
Snippets:43,545
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Complete MongoDB configuration options guide

Source: https://grails.apache.org/docs/latest/grails-data/mongodb/manual/index.html

Complete configuration example showing all MongoDB options with inline documentation.

```groovy
grails {
    mongodb {
        databaseName = "myDb" // the default database name
        host = "localhost" // the host to connect to
        port = 27017 // the port to connect to
        username = ".." // the username to connect with
        password = ".." // the password to connect with
        stateless = false // whether to use stateless sessions by default
        buildIndexes = true // whether GORM creates the indexes declared in mapping blocks by itself on startup
        buildIndexesAsync = false // whether index builds run on a background thread instead of blocking the caller

        // Alternatively, using  'url'
        // url = "mongodb://localhost/mydb"

        options {
            connectionsPerHost = 10 // The maximum number of connections allowed per host
            threadsAllowedToBlockForConnectionMultiplier = 5
            maxWaitTime = 120000 // Max wait time of a blocking thread for a connection.
            connectTimeout = 0 // The connect timeout in milliseconds. 0 == infinite
            socketTimeout = 0 // The socket timeout. 0 == infinite
            socketKeepAlive = false // Whether or not to have socket keep alive turned on
            writeConcern = new com.mongodb.WriteConcern(0, 0, false) // Specifies the number of servers to wait for on the write operation, and exception raising behavior
            sslEnabled = false // Specifies if the driver should use an SSL connection to Mongo
            socketFactory = ... // Specifies the SocketFactory to use for creating connections
        }
    }
}
```

--------------------------------

### Start MongoDB server with mongod

Source: https://grails.apache.org/docs/latest/grails-data/mongodb/manual/index.html

Command to start a MongoDB server after installation.

```bash
MONGO_HOME/bin/mongod
```

--------------------------------

### MongoDB startup output

Source: https://grails.apache.org/docs/latest/grails-data/mongodb/manual/index.html

Example output from starting MongoDB with mongod, showing the server running on port 27017.

```text
2015-11-18T19:38:50.073+0100 I JOURNAL  <<initandlisten>> journal dir=/data/db/journal
2015-11-18T19:38:50.073+0100 I JOURNAL  <<initandlisten>> recover : no journal files present, no recovery needed
2015-11-18T19:38:50.090+0100 I JOURNAL  <<durability>> Durability thread started
2015-11-18T19:38:50.090+0100 I JOURNAL  <<journal writer>> Journal writer thread started
2015-11-18T19:38:50.090+0100 I CONTROL  <<initandlisten>> MongoDB starting : pid=52540 port=27017 dbpath=/data/db 64-bit host=Graemes-iMac.local
2015-11-18T19:38:50.090+0100 I CONTROL  <<initandlisten>> ** WARNING: You are running this process as the root user, which is not recommended.
2015-11-18T19:38:50.090+0100 I CONTROL  <<initandlisten>>
2015-11-18T19:38:50.090+0100 I CONTROL  <<initandlisten>>
2015-11-18T19:38:50.090+0100 I CONTROL  <<initandlisten>> ** WARNING: soft rlimits too low. Number of files is 256, should be at least 1000
2015-11-18T19:38:50.090+0100 I CONTROL  <<initandlisten>> db version v3.0.4
2015-11-18T19:38:50.090+0100 I CONTROL  <<initandlisten>> git version: 0481c958daeb2969800511e7475dc66986fa9ed5
2015-11-18T19:38:50.090+0100 I CONTROL  <<initandlisten>> build info: Darwin mci-osx108-11.build.10gen.cc 12.5.0 Darwin Kernel Version 12.5.0: Sun Sep 29 13:33:47 PDT 2013; root:xnu-2050.48.12~1/RELEASE_X86_64 x86_64 BOOST_LIB_VERSION=1_49
2015-11-18T19:38:50.090+0100 I CONTROL  <<initandlisten>> allocator: system
2015-11-18T19:38:50.090+0100 I CONTROL  <<initandlisten>> options: {}
2015-11-18T19:38:50.176+0100 I NETWORK  <<initandlisten>> waiting for connections on port 27017
```

--------------------------------

### Create an app using the Forge CLI with advanced options (Examples section)

Source: https://grails.apache.org/docs/latest/ref/Command%20Line/create-app.html

Example from the Examples section: create an app using the Forge CLI with advanced options.

```bash
$ grails -t forge create-app bookstore \
    --jdk=17 \
    --data=hibernate5 \
    --features=asciidoctor,grails-gsp
```

--------------------------------

### start(String host, int port)

Source: https://grails.apache.org/docs/latest/api/org/grails/datastore/gorm/neo4j/util/EmbeddedNeo4jServer.html

Starts a server on the given address.

```APIDOC
## start(String host, int port)

### Description
Starts a server on the given address.

### Method
start(String host, int port)

### Parameters
- **host** (String) - The host.
- **port** (int) - The port.

### Return Type
org.neo4j.harness.ServerControls

### Returns
The org.neo4j.harness.ServerControls.
```

--------------------------------

### start(String address)

Source: https://grails.apache.org/docs/latest/api/org/grails/datastore/gorm/neo4j/util/EmbeddedNeo4jServer.html

Starts a server on the given address.

```APIDOC
## start(String address)

### Description
Starts a server on the given address.

### Method
start(String address)

### Parameters
- **address** (String) - The address.

### Return Type
org.neo4j.harness.ServerControls

### Returns
The org.neo4j.harness.ServerControls.
```

--------------------------------

### void start()

Source: https://grails.apache.org/docs/latest/api/org/apache/grails/testing/cleanup/core/DatabaseCleanupStats.html

Starts the timer for individual schema/datasource cleanup. Records the current time as the start time.

```APIDOC
## void start()

### Description
Starts the timer for individual schema/datasource cleanup. Records the current time as the start time.

### Method
void

### Returns
- **void** - No return value.
```

--------------------------------

### Example Book controller

Source: https://grails.apache.org/docs/latest/ref/Tags%20-%20GSP/form.html

Example controller for an application called "shop" that provides list and show actions used by the form examples.

```groovy
class Book {
    def list() {
        [books: Book.list(params)]
    }

    def show() {
        [book: Book.get(params.id)]
    }
}
```

--------------------------------

### start(InetSocketAddress inetAddr)

Source: https://grails.apache.org/docs/latest/api/org/grails/datastore/gorm/neo4j/util/EmbeddedNeo4jServer.html

Starts a server on the given address.

```APIDOC
## start(InetSocketAddress inetAddr)

### Description
Starts a server on the given address.

### Method
start(InetSocketAddress inetAddr)

### Parameters
- **inetAddr** (InetSocketAddress) - The inet address.

### Return Type
org.neo4j.harness.ServerControls

### Returns
The org.neo4j.harness.ServerControls.
```

--------------------------------

### Start Grails server

Source: https://grails.apache.org/docs/latest/guide/security.html

Starts the Grails application server.

```bash
$ grails run-app
```

--------------------------------

### s2-quickstart with uiOnly flag

Source: https://grails.apache.org/docs/latest/guide/security.html

Example of s2-quickstart with the --uiOnly flag. No domain classes are created, but plugin settings are initialized (useful with LDAP, Mock, Shibboleth, etc.).

```bash
./grailsw s2-quickstart --uiOnly
```

--------------------------------

### cron trigger example

Source: https://grails.apache.org/docs/latest/ref/Triggers/cron.html

Defines a Grails job with a cron trigger that fires every 6 seconds starting at 15:00, with a 10-second start delay and an optional time zone.

```groovy
class MyJob {

    static triggers = {
        cron(
            name: 'cronTrigger',
            startDelay: 10000,
            cronExpression: '0/6 * 15 * * ?',
            timeZone: TimeZone.getTimeZone('GMT-8') // optional
        )
    }

    void execute() {
        println 'Job run!'
    }
}
```

--------------------------------

### start(String host, int port, File dataLocation, Map<String, Object> options)

Source: https://grails.apache.org/docs/latest/api/org/grails/datastore/gorm/neo4j/util/EmbeddedNeo4jServer.html

Starts a server on the given address with the specified data location and options.

```APIDOC
## start(String host, int port, File dataLocation, Map<String, Object> options)

### Description
Starts a server on the given address with the specified data location and options.

### Method
start(String host, int port, File dataLocation, Map<String, Object> options)

### Parameters
- **host** (String) - The host.
- **port** (int) - The port.
- **dataLocation** (File) - The data location.
- **options** (Map<String, Object>) - The options.

### Return Type
org.neo4j.harness.ServerControls

### Returns
The org.neo4j.harness.ServerControls.
```

--------------------------------

### RxGORM reactive Book.get example

Source: https://grails.apache.org/docs/latest/guide/async.html

Example of using RxGORM to retrieve a Book asynchronously. The get method returns an Observable and subscribe is used to handle the result, printing the title.

```groovy
Book.get(id)
    .subscribe { Book it ->
    println "Title = ${it.title}"
}
```

--------------------------------

### s2-quickstart with requestmap class

Source: https://grails.apache.org/docs/latest/guide/security.html

Example of s2-quickstart that creates Person, Authority, and Requestmap domain classes in the com.yourapp package.

```bash
./grailsw s2-quickstart com.yourapp Person Authority Requestmap
```

--------------------------------

### Old Mixin-Based Unit Test Example

Source: https://grails.apache.org/docs/latest/guide/single.html

Example test using the old mixin framework with @TestFor and @Mock annotations. This is shown as a starting point for conversion to the new trait-based framework.

```groovy
@TestFor(AuthorController)
@Mock(Author)
class AuthorControllerTests {

    @Test
    void testIndex() {
        controller.index()
        assert response.text == 'Hello'
    }
}
```

--------------------------------

### start(String address, File dataLocation, Map<String, Object> options)

Source: https://grails.apache.org/docs/latest/api/org/grails/datastore/gorm/neo4j/util/EmbeddedNeo4jServer.html

Starts a server on the given address with the specified data location and options.

```APIDOC
## start(String address, File dataLocation, Map<String, Object> options)

### Description
Starts a server on the given address with the specified data location and options.

### Method
start(String address, File dataLocation, Map<String, Object> options)

### Parameters
- **address** (String) - The address.
- **dataLocation** (File) - The data location.
- **options** (Map<String, Object>) - The options.

### Return Type
org.neo4j.harness.ServerControls

### Returns
The org.neo4j.harness.ServerControls.
```

--------------------------------

### JSON response for GET /books/1.json

Source: https://grails.apache.org/docs/latest/guide/REST.html

Example JSON response when requesting the resource with the .json extension.

```json
{"id":1,"title":"The Stand"}
```

--------------------------------

### Run greet command with arguments and options

Source: https://grails.apache.org/docs/latest/guide/commandLine.html

Shows how to run the greet command with various arguments and options. The comments indicate the expected behavior for each invocation.

```bash
# Greet the user with the default message
./gradlew runCommand -Pargs="greet"

# Greet a specific user
./gradlew runCommand -Pargs="greet Alice"

# Greet loudly
./gradlew runCommand -Pargs="greet --loud"

# Greet a specific user loudly
./gradlew runCommand -Pargs="greet Alice --loud"

```

--------------------------------

### isNotAvailable tag examples

Source: https://grails.apache.org/docs/latest/ref/Tags%20-%20GSP/isNotAvailable.html

Two examples of the <plugin:isNotAvailable> tag. The first checks for the spring-security-core plugin, the second checks for the resources plugin with a specific version. Both render their body only if the plugin is not installed.

```HTML
<plugin:isNotAvailable name="spring-security-core">
You don't have Spring Security installed!
</plugin:isNotAvailable>

<plugin:isNotAvailable name="resources" version="1.2">
  <%-- Do something unless version 1.2 of Resources plugin is installed --%>
</plugin:isNotAvailable>
```

--------------------------------

### Setup.groovy for custom datastore

Source: https://grails.apache.org/docs/latest/grails-data/developer-manual/index.html

Example Setup.groovy for a custom datastore. The static setup method initializes the Datastore and returns a Session, given a list of classes to configure. Some setup code is omitted for clarity.

```groovy
class Setup {

    static destroy() {
        // noop
    }
    static Session setup(classes) {

        def ctx = new GenericApplicationContext()
        ctx.refresh()
        def simple = new SimpleMapDatastore(ctx)

        ...
        for (cls in classes) {
            simple.mappingContext.addPersistentEntity(cls)
        }

        ...
        def enhancer = new GormEnhancer(simple, new DatastoreTransactionManager(datastore: simple))
        enhancer.enhance()

        simple.mappingContext.addMappingContextListener({ e -> enhancer.enhance e } as MappingContext.Listener)

        simple.applicationContext.addApplicationListener new DomainEventListener(simple)
        simple.applicationContext.addApplicationListener new AutoTimestampEventListener(simple)

        return simple.connect()
    }
}
```

--------------------------------

### start(File dataLocation, Map<String, Object> options)

Source: https://grails.apache.org/docs/latest/api/org/grails/datastore/gorm/neo4j/util/EmbeddedNeo4jServer.html

Starts a server on a random free port with the given data location and options.

```APIDOC
## start(File dataLocation, Map<String, Object> options)

### Description
Starts a server on a random free port with the given data location and options.

### Method
start(File dataLocation, Map<String, Object> options)

### Parameters
- **dataLocation** (File) - The data location.
- **options** (Map<String, Object>) - The options.

### Return Type
org.neo4j.harness.ServerControls

### Returns
The server controls.
```

--------------------------------

### XML response for GET /books/1

Source: https://grails.apache.org/docs/latest/guide/REST.html

Example XML response returned when accessing the resource with the default format.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<book id="1">
    <title>The Stand</title>
</book>
```

--------------------------------

### Get current action name in a Grails controller

Source: https://grails.apache.org/docs/latest/ref/Controllers/actionName.html

Use the actionName property inside a controller to get the name of the currently executing action. In this example, it is used in a log message and to render a view with the same name as the action.

```groovy
class BookController {
    def list() {
        log.info "Executing action $actionName"

        render(view: actionName)
    }
}
```

--------------------------------

### start(String host, int port, File dataLocation)

Source: https://grails.apache.org/docs/latest/api/org/grails/datastore/gorm/neo4j/util/EmbeddedNeo4jServer.html

Starts a server on the given address with the specified data location.

```APIDOC
## start(String host, int port, File dataLocation)

### Description
Starts a server on the given address with the specified data location.

### Method
start(String host, int port, File dataLocation)

### Parameters
- **host** (String) - The host.
- **port** (int) - The port.
- **dataLocation** (File) - The data location.

### Return Type
org.neo4j.harness.ServerControls

### Returns
The org.neo4j.harness.ServerControls.
```

--------------------------------

### start(String address, File dataLocation)

Source: https://grails.apache.org/docs/latest/api/org/grails/datastore/gorm/neo4j/util/EmbeddedNeo4jServer.html

Starts a server on the given address with the specified data location.

```APIDOC
## start(String address, File dataLocation)

### Description
Starts a server on the given address with the specified data location.

### Method
start(String address, File dataLocation)

### Parameters
- **address** (String) - The address.
- **dataLocation** (File) - The data location.

### Return Type
org.neo4j.harness.ServerControls

### Returns
The org.neo4j.harness.ServerControls.
```

--------------------------------

### Usage examples for --list-features

Source: https://grails.apache.org/docs/latest/ref/Command%20Line/list-features.html

Usage examples for listing features with create-app and create-plugin. Both commands require the Forge CLI and the --list-features flag.

```bash
$ grails -t forge create-app --list-features
$ grails -t forge create-plugin --list-features
```

--------------------------------

### Invoke named queries with list, get, count, find methods

Source: https://grails.apache.org/docs/latest/ref/Domain%20Classes/namedQueries.html

Examples of invoking named queries using various methods: list, list with pagination, get, count, findAllWhere, findWhere, dynamic finders, and chaining with additional criteria.

```groovy
// get all recent publications...
def recentPubs = Publication.recentPublications.list()

// get up to 10 recent publications, skip the first 5...
def recentPubs = Publication.recentPublications.list(max: 10, offset: 5)

// get a single recent publication
def recentPub = Publication.recentPublications.get()

// get the number of recent publications...
def numberOfRecentPubs = Publication.recentPublications.count()

// get a recent publication with a specific id...
def pub = Publication.recentPublications.get(42)

// get all recent publications where title = 'Some Title'
def pubs = Publication.recentPublications.findAllWhere(title: 'Some Title')

// get a recent publication where title = 'Some Title'
def pub = Publication.recentPublications.findWhere(title: 'Some Title')

// dynamic finders are supported
def pubs = Publication.recentPublications.findAllByTitle('Some Title')

// get all old publications with more than 350 pages
def pubs = Publication.oldPublicationsLargerThan(350).list()

// get all old publications with more than 350 pages
// and the word 'Grails' in the title
def pubs = Publication.oldPublicationsLargerThan(350).findAllByTitleLike('%Grails%')

// get all recent publications with 'Book' in their title
def pubs = Publication.recentPublicationsWithBookInTitle().list()
```

--------------------------------

### Add mongodb plugin dependency in build.gradle

Source: https://grails.apache.org/docs/latest/grails-data/mongodb/manual/index.html

Add the GORM for MongoDB plugin dependency to build.gradle to get started with MongoDB in Grails.

```groovy
dependencies {
    compile 'org.grails.plugins:mongodb:8.0.0-RC1'
}
```

--------------------------------

### HolyGrailQuest class

Source: https://grails.apache.org/docs/latest/guide/single.html

A simple Groovy class representing a quest that prints a message when started. Used as a dependency for the knight bean in the BeanBuilder examples.

```groovy
class HolyGrailQuest {
    def start() { println "lets begin" }
}
```

--------------------------------

### create-domain-class command examples

Source: https://grails.apache.org/docs/latest/ref/Command%20Line/create-domain-class.html

Shows the command with no argument (prompts for name), with a simple name, and with a fully qualified package name.

```bash
grails create-domain-class

```

```bash
grails create-domain-class Book

```

```bash
grails create-domain-class org.bookstore.Book

```

--------------------------------

### Run s2-quickstart initialization script

Source: https://grails.apache.org/docs/latest/guide/security.html

Run the s2-quickstart initialization script to set up essential classes and configurations. For Grails plugins, ensure the web-plugin profile is used; otherwise dependencies will not be met.

```bash
./gradlew runCommand -Pargs="s2-quickstart com.yourapp User Role"
```

--------------------------------

### Get Grails version with GrailsUtil.grailsVersion

Source: https://grails.apache.org/docs/latest/guide/conf.html

Retrieves the Grails version using the `GrailsUtil` class. The `...` represents omitted code in the original example.

```groovy
import grails.util.GrailsUtil
...
def grailsVersion = GrailsUtil.grailsVersion
```

--------------------------------

### Generate domain classes with s2-quickstart

Source: https://grails.apache.org/docs/latest/guide/security.html

Run the s2-quickstart script to generate domain classes and add initial configuration settings in application.groovy.

```bash
./grailsw s2-quickstart com.yourapp User Role
```

--------------------------------

### Basic HQL query with Book.findAll

Source: https://grails.apache.org/docs/latest/grails-data/hibernate5/manual/index.html

Basic HQL query using the findAll method. This example finds all books whose title starts with 'Lord of the'.

```groovy
def results =
      Book.findAll("from Book as b where b.title like 'Lord of the%'")
```

--------------------------------

### Import @Async for asynchronous execution

Source: https://grails.apache.org/docs/latest/guide/single.html

Starts an example of using @Async with @EnableAsync to run work off the request thread on demand. The snippet is incomplete as shown in the source.

```groovy
import org.springframework.scheduling.annotation.Async

class NotificationService {
```

--------------------------------

### matchStart(String pattern, String path)

Source: https://grails.apache.org/docs/latest/api/org/grails/io/support/AntPathMatcher.html

Matches the beginning of the given path against the given pattern.

```APIDOC
## matchStart(String pattern, String path)

### Description
Matches the beginning of the given path against the given pattern.

### Method
matchStart

### Parameters
- **pattern** (String) - Required - The pattern
- **path** (String) - Required - The path

### Returns
- **boolean** - Whether the beginning of the path matches the pattern
```

--------------------------------

### matchStart(String pattern, String path)

Source: https://grails.apache.org/docs/latest/api/org/grails/io/support/AntPathMatcher.html

Matches the beginning of the given path against the given pattern.

```APIDOC
## matchStart(String pattern, String path)

### Description
Matches the beginning of the given path against the given pattern.

### Method
public boolean matchStart(java.lang.String pattern, java.lang.String path)

### Parameters
- **pattern** (String) - Required - The pattern to match against.
- **path** (String) - Required - The path to test.

### Returns
- **boolean** - true if the beginning of the path matches the pattern, false otherwise.
```

--------------------------------

### Async rendering with startAsync and complete

Source: https://grails.apache.org/docs/latest/guide/async.html

Use startAsync to get an AsyncContext, then start a block that saves a book, renders a template, and calls complete() to terminate the connection.

```groovy
def index() {
    def ctx = startAsync()
    ctx.start {
        new Book(title:"The Stand").save()
        render template:"books", model:[books:Book.list()]
        ctx.complete()
    }
}
```

--------------------------------

### Binding request body to command object with curl examples

Source: https://grails.apache.org/docs/latest/guide/single.html

Shows a controller action that binds the request body to a command object. The curl examples demonstrate JSON and XML requests; the body is parsed based on content type. The body is not parsed for GET, DELETE, or zero content length.

```groovy
package bindingdemo

class DemoController {

    def createWidget(Widget w) {
        render "Name: ${w?.name}, Size: ${w?.size}"
    }
}

class Widget {
    String name
    Integer size
}
```

```bash
$ curl -H "Content-Type: application/json" -d '{"name":"Some Widget","42"}'[size] localhost:8080/demo/createWidget
 Name: Some Widget, Size: 42

$ curl -H "Content-Type: application/xml" -d '<widget><name>Some Other Widget</name><size>2112</size></widget>' localhost:8080/bodybind/demo/createWidget
 Name: Some Other Widget, Size: 2112
```

--------------------------------

### Navigate into the project directory

Source: https://grails.apache.org/docs/latest/guide/gettingStarted.html

Navigates into the newly created project directory.

```bash
$ cd myapp
```

--------------------------------

### Add Spring Security plugin dependency to build.gradle

Source: https://grails.apache.org/docs/latest/guide/security.html

Add the Spring Security plugin dependency to the dependencies block in build.gradle as the first step of the quick start guide.

```groovy
implementation 'org.apache.grails:grails-spring-security'
```

--------------------------------

### Get help for create-app command with --help

Source: https://grails.apache.org/docs/latest/ref/Command%20Line/help.html

Shows detailed help for the `create-app` command, including its usage line, arguments, and options such as `--features`, `--jdk`, `--list-features`, `-s, --servlet`, and `-t, --test`.

```shell
grails create-app --help

```

--------------------------------

### Cache a criteria query with cache true

Source: https://grails.apache.org/docs/latest/grails-data/hibernate5/manual/index.html

Caches a criteria query by calling cache true inside the criteria block. The example finds people with a first name starting with 'Fr'.

```groovy
def people = Person.withCriteria {
    like('firstName', 'Fr%')
    cache true
}

```

--------------------------------

### s2-quickstart general format

Source: https://grails.apache.org/docs/latest/guide/security.html

General format for the s2-quickstart script. Creates user and role classes (and optionally a requestmap class) in the specified package. If a role-group name is given with --groupClassName, role/group classes are also generated. If --uiOnly is specified, no domain classes are created but plugin settings are initialized.

```bash
./grailsw s2-quickstart DOMAIN_CLASS_PACKAGE USER_CLASS_NAME ROLE_CLASS_NAME [REQUESTMAP_CLASS_NAME] [--groupClassName=GROUP_CLASS_NAME]
```

--------------------------------

### Render an inline GSON view with render()

Source: https://grails.apache.org/docs/latest/guide/theWebLayer.html

Use the `render` method with an inline template string and a model map to get a `JsonRenderResult`. The example asserts the parsed JSON via `result.json.person.name`.

```groovy
void "Test render a raw GSON view"() {
    when:"A gson view is rendered"
    JsonRenderResult result = render '''
        model {
            String person
        }
        json.person {
            name person
        }
''', [person:"bob"]

    then:"The json is correct"
    result.json.person.name == 'bob'
}
```

--------------------------------

### start(File dataLocation)

Source: https://grails.apache.org/docs/latest/api/org/grails/datastore/gorm/neo4j/util/EmbeddedNeo4jServer.html

Starts a server on a random free port with the given data location.

```APIDOC
## start(File dataLocation)

### Description
Starts a server on a random free port.

### Method
start(File dataLocation)

### Parameters
- **dataLocation** (File) - The data location.

### Return Type
org.neo4j.harness.ServerControls

### Returns
The server controls.
```

--------------------------------

### start(InetSocketAddress inetAddr, File dataLocation, Map<String, Object> options)

Source: https://grails.apache.org/docs/latest/api/org/grails/datastore/gorm/neo4j/util/EmbeddedNeo4jServer.html

Starts a server on the given address with the specified data location and options.

```APIDOC
## start(InetSocketAddress inetAddr, File dataLocation, Map<String, Object> options)

### Description
Starts a server on the given address with the specified data location and options.

### Method
start(InetSocketAddress inetAddr, File dataLocation, Map<String, Object> options)

### Parameters
- **inetAddr** (InetSocketAddress) - The inet address.
- **dataLocation** (File) - The data location.
- **options** (Map<String, Object>) - The options.

### Return Type
org.neo4j.harness.ServerControls

### Returns
The org.neo4j.harness.ServerControls.
```
Tokens:
Raw