mozIStorageConnection.idl

Go to the documentation of this file.

/* -*- Mode: idl; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is Oracle Corporation code.
 *
 * The Initial Developer of the Original Code is
 *  Oracle Corporation
 * Portions created by the Initial Developer are Copyright (C) 2004
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Vladimir Vukicevic <vladimir.vukicevic@oracle.com>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"

interface mozIStorageFunction;
interface mozIStorageStatement;
interface nsIFile;

[scriptable, uuid(623b8b2e-c9f9-4cc3-b15a-f3c96df2cc1c)]
interface mozIStorageConnection : nsISupports {
  /*
   * Initialization and status
   */

  readonly attribute boolean connectionReady;

  readonly attribute AUTF8String databaseName;

  readonly attribute long long lastInsertRowID;

  readonly attribute long lastError;

  readonly attribute AUTF8String lastErrorString;

  /*
   * Statement creation
   */

  mozIStorageStatement createStatement (in AUTF8String aSQLStatement);

  void executeSimpleSQL (in AUTF8String aSQLStatement);

  boolean tableExists (in AUTF8String aTableName);

  /*
   * Transactions
   */

  readonly attribute boolean transactionInProgress;

  void beginTransaction ();

  void commitTransaction ();

  void rollbackTransaction ();

  /*
   * Tables
   */

  void createTable(in string aTableName,
                   in string aTableSchema);

  /*
   * Functions and Triggers
   */

  void createFunction (in string aFunctionName,
                       in long aNumArguments,
                       in mozIStorageFunction aFunction);

  const long TRIGGER_EVENT_DELETE = 1;
  const long TRIGGER_EVENT_INSERT = 2;
  const long TRIGGER_EVENT_UPDATE = 3;

  void createTrigger (in string aTriggerName,
                      in long aTriggerType,
                      in string aTableName,
                      in string aTriggerFunction,
                      in string aParameters);

  void removeTrigger (in string aTriggerName);
};

---