////
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
////


== delete



=== Purpose


Deletes a persistent instance.


=== Examples


[source,groovy]
----
def book = Book.get(1)
book.delete()
----


=== Description


The `delete` method informs the persistence context that a persistent instance should be deleted. Equivalent to the Hibernate https://javadoc.io/doc/org.hibernate/hibernate-core/{hibernate5Version}/org/hibernate/Session.html#delete(java/lang/Object)[delete] method.

WARNING: Calling `delete` on a transient instance will result in an error

Parameters:

* `flush` - If set to `true` the persistent context will be flushed resulting in the instance being deleted immediately. For example:

[source,groovy]
----
def book = Book.get(1)
book.delete(flush: true)
----
