busymachines.pureharm.phdb.DAOAlgebra.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pureharm-db-core_2.13.0-RC2 Show documentation

pureharm-db-core

The newest version!

/**
  * Copyright (c) 2019 BusyMachines
  *
  * See company homepage at: https://www.busymachines.com/
  *
  * Licensed 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
  *
  * http://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.
  */
package busymachines.pureharm.phdb

import busymachines.pureharm.effects.Traverse

/**
  *
  * @tparam E
  *   The type of elements manipulated by this DAO
  * @tparam PK
  *   The "primary key", or "id" if you will, by which elements
  *   of type `E` are identified.
  * @author Lorand Szakacs, https://github.com/lorandszakacs
  * @since 04 Apr 2019
  */
trait DAOAlgebra[R[_], E, PK] {
  def find(pk: PK): R[Option[E]]

  def retrieve(pk: PK): R[E]

  def insert(e: E): R[PK]

  def insertMany(es: Iterable[E]): R[Unit]

  def update(e: E): R[E]

  def updateMany[M[_]: Traverse](es: M[E]): R[Unit]

  def delete(pk: PK): R[Unit]

  def deleteMany(pks: Iterable[PK]): R[Unit]

  def exists(pk: PK): R[Boolean]

  def existsAtLeastOne(pks: Iterable[PK]): R[Boolean]

  def existAll(pks: Iterable[PK]): R[Boolean]
}