io.baratine.db.DatabaseServiceSync Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
A reactive Java web server.
There is a newer version: 1.0.1
/*
 * Copyright (c) 1998-2015 Caucho Technology -- all rights reserved
 *
 * This file is part of Baratine(TM)(TM)
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Baratine 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 2 of the License, or
 * (at your option) any later version.
 *
 * Baratine 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, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Baratine; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 */

package io.baratine.db;

import io.baratine.service.Service;
import io.baratine.stream.ResultStreamBuilderSync;


/**
 * Experimental API to the internal Kelp/Kraken database.
 *
 * 
 * @Inject @Lookup("bardb:///")
 * DatabaseServce _db;
 * 
 * serviceManager.lookup("bardb:///").as(DatabaseService.class);
 * 
 */
public interface DatabaseServiceSync extends DatabaseService
{
  /**
   * Synchronous execution for insert and create statements
   * 
   * @param sql the query to be executed
   * @param param option parameters for the query
   * @return the result of the query.
   */
  Object exec(String sql, Object ...param);
  
  /**
   * Prepare for later execution. The returned cursor is not thread safe.
   * 
   * @param sql the query to execute
   * @return the prepared query
   */
  CursorPrepareSync prepare(String sql);
  
  /**
   * Synchronous select query that returns a single result.
   *   
   * @param sql the select query to execute
   * @param param optional parameters for the select query
   * @return the result cursor, or null if the query finds no items 
   */
  Cursor findOne(String sql, Object ...param);
  
  Iterable findAll(String sql, Object ...param);
  
  Iterable findAllLocal(String sql, Object ...param);
  
  @Override
  ResultStreamBuilderSync find(String sql, Object ...param);
  
  @Override
  ResultStreamBuilderSync findLocal(String sql, Object ...param);
  
  /**
   * Set a watch callback on a database to be notified when the row changes.
   * 
   * @param watch callback for change events to the row
   * @param sql the watch query to select rows to watch
   * @param param parameters for the query
   * @return true on success
   */
  boolean watch(@Service DatabaseWatch watch, String sql, Object ...param);
  boolean unwatch(@Service DatabaseWatch watch, String sql, Object ...param);
}