Realizar operaciones CRUD

Datos de muestra

Los ejemplos de esta guía utilizan la entidad Movie, que representa la colección sample_mflix.movies del conjuntos de datos de muestras de Atlas. La entidad Movie tiene la siguiente definición:

import com.mongodb.hibernate.annotations.ObjectIdGenerator;
import org.bson.types.ObjectId;
import java.time.Instant;
import java.util.List;
import jakarta.persistence.Embedded;
import jakarta.persistence.Entity;
import jakarta.persistence.FetchType;
import jakarta.persistence.Id;
import jakarta.persistence.OneToMany;
import jakarta.persistence.Table;
@Entity
@Table(name = "movies")
public class Movie {
   @Id
   @ObjectIdGenerator
   private ObjectId id;
   private String title;
   private String plot;
   private int year;
   private List<String> cast;
   private List<String> directors;
   private Instant released;
   @Embedded
   private Awards awards;
   @OneToMany(mappedBy = "movie", fetch = FetchType.LAZY)
   private List<Comment> comments;
   public Movie(String title, String plot, int year, List<String> cast, List<String> directors, Instant released, Awards awards) {
      this.title = title;
      this.plot = plot;
      this.year = year;
      this.cast = cast;
      this.directors = directors;
      this.released = released;
      this.awards = awards;
   }
   public Movie() {
   }
   public ObjectId getId() {
      return id;
   }
   public String getTitle() {
      return title;
   }
   public void setTitle(String title) {
      this.title = title;
   }
   public String getPlot() {
      return plot;
   }
   public void setPlot(String plot) {
      this.plot = plot;
   }
   public int getYear() {
      return year;
   }
   public void setYear(int year) {
      this.year = year;
   }
   public List<String> getCast() {
      return cast;
   }
   public void setCast(List<String> cast) {
      this.cast = cast;
   }
   public List<String> getDirectors() {
      return directors;
   }
   public void setDirectors(List<String> directors) {
      this.directors = directors;
   }
   public Awards getAwards() {
      return awards;
   }
   public void setAwards(Awards awards) {
      this.awards = awards;
   }
   public Instant getReleased() {
      return released;
   }
   public void setReleased(Instant released) {
      this.released = released;
   }
   public List<Comment> getComments() {
      return comments;
   }
   public void setComments(List<Comment> comments) {
      this.comments = comments;
   }
}

Para aprender a crear una aplicación Java que utilice la extensión MongoDB para Hibernate ORM para interactuar con esta colección de muestra de MongoDB, consulta el tutorial Primeros pasos.

var sf = HibernateUtil.getSessionFactory();
Session session = sf.openSession();
Transaction tx = session.beginTransaction();
// ... Perform CRUD operations here
tx.commit();
session.close();
sf.close();

 // Replace <persistence unit> with the name of your persistence unit in the persistence.xml file
 EntityManagerFactory emf = Persistence.createEntityManagerFactory("<persistence unit>");
 EntityManager entityManager = entityManagerFactory.createEntityManager();
 entityManager.getTransaction().begin();
 // ... Perform CRUD operations here
entityManager.getTransaction().commit();
entityManager.close();
emf.close;

Ejemplo

El siguiente ejemplo crea una nueva instancia de entidad Movie y utiliza el método persist() para insertar un documento correspondiente en la colección sample_mflix.movies:

var myMovie = new Movie();
myMovie.setTitle("Knives Out");
myMovie.setYear(2019);
myMovie.setCast(List.of("Ana de Armas", "Daniel Craig", "Chris Evans"));
myMovie.setPlot("Detective Benoit Blanc investigates the mysterious death of crime novelist Harlan Thrombey, " +
        "unraveling lies as every Thrombey family member becomes a suspect.");
session.persist(myMovie);

var myMovie = new Movie();
myMovie.setTitle("Knives Out");
myMovie.setYear(2019);
myMovie.setCast(List.of("Ana de Armas", "Daniel Craig", "Chris Evans"));
myMovie.setPlot("Detective Benoit Blanc investigates the mysterious death of crime novelist Harlan Thrombey, " +
        "unraveling lies as every Thrombey family member becomes a suspect.");
entityManager.persist(myMovie);

Ejemplo de devolución de un documento

Para recuperar solo un documento que coincida con tus criterios de query, encadena el método getSingleResult() al método createQuery(). El siguiente ejemplo recupera un documento que tiene un valor de title de "Boyhood" de la colección sample_mflix.movies:

var singleResult = session.createQuery("from Movie where title = :t", Movie.class)
                          .setParameter("t", "Boyhood")
                          .getSingleResult();
System.out.println("Title: " + singleResult.getTitle() + ", Year: " + singleResult.getYear());

Title: Boyhood, Year: 2014

var singleResult = entityManager.createQuery("select m from Movie m where m.title = :t", Movie.class)
                          .setParameter("t", "Boyhood")
                          .getSingleResult();
System.out.println("Title: " + singleResult.getTitle() + ", Year: " + singleResult.getYear());

Title: Boyhood, Year: 2014

Ejemplo de retorno de varios documentos

El siguiente ejemplo llama al método createQuery() en una sesión para recuperar documentos de la colección sample_mflix.movies. El código utiliza HQL y JPQL para devolver documentos que tienen un valor de year igual a 1920 e imprime sus valores de title:

var results = session.createQuery("from Movie where year = :y", Movie.class)
                    .setParameter("y", 1920)
                    .getResultList();
results.forEach(movie -> System.out.println(movie.getTitle()));

High and Dizzy
One Week
The Saphead
The Daughter of Dawn

var results = entityManager.createQuery("select m from Movie m where m.year = :y", Movie.class)
                    .setParameter("y", 1920)
                    .getResultList();
results.forEach(movie -> System.out.println(movie.getTitle()));

High and Dizzy
One Week
The Saphead
The Daughter of Dawn

Actualizar un ejemplo

El siguiente ejemplo recupera un documento por su valor ObjectId. Luego, el ejemplo llama al método setTitle() de la entidad Movie para actualizar el valor title del documento a "Jurassic Park I":

// Your ObjectId value might differ
Movie movieById = session.get(Movie.class, new ObjectId("573a1399f29313caabcedc5d"));
movieById.setTitle("Jurassic Park I");
session.persist(movieById);

// Your ObjectId value might differ
Movie movieById = entityManager.find(Movie.class, new ObjectId("573a1399f29313caabcedc5d"));
movieById.setTitle("Jurassic Park I");
entityManager.persist(movieById);

Actualizar múltiples ejemplo

El siguiente ejemplo actualiza el valor de title de los documentos coincidentes de "The Three Stooges" a "The 3 Stooges". Luego, el ejemplo llama al método executeUpdate() para aplicar los cambios a la base de datos:

var updateResult = session.createMutationQuery(
    "update Movie set title = :new where title = :old")
    .setParameter("new", "The 3 Stooges")
    .setParameter("old", "The Three Stooges")
    .executeUpdate();
System.out.println("Number of movies updated: " + updateResult);

Number of movies updated: 2

var updateResult = entityManager.createQuery(
    "update Movie m set m.title = :new where m.title = :old")
    .setParameter("new", "The 3 Stooges")
    .setParameter("old", "The Three Stooges")
    .executeUpdate();
System.out.println("Number of movies updated: " + updateResult);

Number of movies updated: 2

La cláusula SET de una instrucción de actualización masiva también puede usar una expresión en lugar de un valor literal. La expresión puede hacer referencia al campo que se está actualizando o a otro campo de la entidad.

El siguiente ejemplo utiliza una expresión aritmética para incrementar el valor year de los documentos que tienen un valor title igual a "The 3 Stooges":

var updateResult = session.createMutationQuery(
    "update Movie m set m.year = m.year + 1 where m.title = :title")
    .setParameter("title", "The 3 Stooges")
    .executeUpdate();
System.out.println("Number of movies updated: " + updateResult);

Number of movies updated: 2

El siguiente ejemplo utiliza una referencia de campo para establecer el valor plot para que coincida con el valor title para los documentos que tienen un valor year de 1920:

var updateResult = session.createMutationQuery(
    "update Movie m set m.plot = m.title where m.year = :year")
    .setParameter("year", 1920)
    .executeUpdate();
System.out.println("Number of movies updated: " + updateResult);

Number of movies updated: 4

Ejemplo de actualización múltiple basada en lógica condicional

El siguiente ejemplo utiliza una expresión CASE para establecer el valor plot dependiendo de si el valor year de cada documento es posterior al año 2000. La extensión Hibernate ORM traduce la expresión CASE al operador $switch de MongoDB y aplica la actualización mediante una etapa de canalización $set:

var updateResult = session.createMutationQuery(
    "update Movie m set m.plot = case when m.year > 2000 then 'Modern release' "
        + "else 'Classic release' end where m.title = :title")
    .setParameter("title", "The 3 Stooges")
    .executeUpdate();
System.out.println("Number of movies updated: " + updateResult);

Number of movies updated: 2

Para obtener más información sobre las expresiones CASE, consulte la sección Expresiones de casos de uso para lógica condicional en la guía Especificar una consulta.

Requisitos de la entidad

La extensión Hibernate ORM crea el filtro para una operación upsert a partir del identificador de su entidad, por lo que su aplicación debe asignar el valor del identificador antes de llamar a upsert().

El método upsert() no genera valores de identificador, incluso si su entidad utiliza la anotación @ObjectIdGenerator. Si no asigna un valor de identificador, la extensión Hibernate ORM almacena el documento con un valor null _id.

Puedes usar la anotación @Column(updatable = false) para proteger un campo de las actualizaciones durante una operación de inserción/actualización. La siguiente definición de entidad Movie anota el campo released con @Column(updatable = false), lo que indica a la extensión ORM de Hibernate que escriba en el campo cuando inserte un documento, pero que lo omita cuando actualice un documento existente:

@Entity
@Table(name = "movies")
public class Movie {
   @Id
   @ObjectIdGenerator
   private ObjectId id;
   private String title;
   private int year;
   @Column(updatable = false)
   private Instant released;
   // Getters and setters omitted
}

La extensión Hibernate ORM envía los campos que son tanto insertables como actualizables en el operador $set de la instrucción de actualización generada. Envía los campos que solo son insertables, como los campos anotados con @Column(updatable = false), en el operador $setOnInsert.

Insertar un ejemplo

El siguiente ejemplo crea una instancia de entidad Movie y la pasa al método upsert(). Si existe un documento con el valor ObjectId especificado, la extensión Hibernate ORM actualiza los valores title y year de dicho documento. De lo contrario, la extensión Hibernate ORM inserta un nuevo documento.

try (StatelessSession statelessSession = sf.openStatelessSession()) {
    var movie = new Movie();
    movie.setId(new ObjectId("573a1398f29313caabce9682"));
    movie.setTitle("The General");
    movie.setYear(1926);
    movie.setReleased(Instant.parse("1927-02-24T00:00:00Z"));
    statelessSession.upsert(movie);
}

Ejemplo múltiple de inserción/actualización

Para insertar o actualizar varias instancias de entidad en una sola operación, pase una lista de instancias al método upsertMultiple(). El siguiente ejemplo inserta o actualiza dos instancias de entidad Movie:

try (StatelessSession statelessSession = sf.openStatelessSession()) {
    var firstMovie = new Movie();
    firstMovie.setId(new ObjectId("573a1398f29313caabce9682"));
    firstMovie.setTitle("The General");
    firstMovie.setYear(1926);
    var secondMovie = new Movie();
    secondMovie.setId(new ObjectId("573a1398f29313caabce9683"));
    secondMovie.setTitle("Metropolis");
    secondMovie.setYear(1927);
    statelessSession.upsertMultiple(List.of(firstMovie, secondMovie));
}

Limitaciones de Upsert

Las siguientes asignaciones de entidades no son compatibles con las operaciones de inserción/actualización. Cuando se inserta/actualiza una entidad que utiliza una de estas asignaciones, la extensión Hibernate ORM genera un error FeatureNotSupportedException:

• Entidades que tienen un campo anotado con @Version.

• Entidades que tienen un campo anotado con @Column(insertable = false). El lenguaje de consulta de MongoDB no proporciona ninguna forma de escribir un campo solo cuando una operación coincide con un documento existente.

• Entidades cuyo único atributo persistente es el identificador. Una operación de actualización o inserción en este tipo de entidad no tiene campos que actualizar, por lo que la extensión Hibernate ORM rechaza la operación.

Borrar un ejemplo

El siguiente ejemplo recupera un documento por su valor de ObjectId. Luego, el ejemplo llama al método remove() en una sesión para borrar el documento correspondiente de la colección sample_mflix.movies:

// Your ObjectId value might differ
Movie movieToDelete = session.get(Movie.class, new ObjectId("573a1399f29313caabcedc5d"));
session.remove(movieToDelete);

// Your ObjectId value might differ
Movie movieToDelete = entityManager.find(Movie.class, new ObjectId("573a1399f29313caabcedc5d"));
entityManager.remove(movieToDelete);

Borrar Múltiples ejemplos

El siguiente ejemplo elimina todos los documentos que tienen un valor year de 1920 de la colección sample_mflix.movies. El ejemplo pasa una instrucción de borrado al método createMutationQuery() y luego llama al método executeUpdate() para aplicar los cambios a la base de datos:

var deleteResult = session.createMutationQuery(
    "delete Movie where year = :y")
    .setParameter("y", 1920)
    .executeUpdate();
System.out.println("Number of movies deleted: " + deleteResult);

Number of movies deleted: 4

var deleteResult = entityManager.createQuery(
    "delete Movie m where m.year = :y")
    .setParameter("y", 1920)
    .executeUpdate();
System.out.println("Number of movies deleted: " + deleteResult);

Number of movies deleted: 4