OrientDB - 钩子

OrientDB Hooks只是数据库术语中的触发器，它在用户应用程序中的每个 CRUD 操作之前和之后启用内部事件。您可以使用挂钩来编写自定义验证规则、强制安全性或安排外部事件（例如针对关系 DBMS 进行复制）。

OrientDB 支持两种钩子 -

动态挂钩- 触发器，可以在类级别和/或文档级别构建。

Java（本机）Hook - 触发器，可以使用 Java 类构建。

动态挂钩

动态钩子比 Java 钩子更灵活，因为它们可以在运行时更改，并且可以在需要时按文档运行，但比 Java 钩子慢。

要对文档执行挂钩，首先允许您的类扩展OTriggered基类。稍后，为感兴趣的事件定义自定义属性。以下是可用的事件。

onBeforeCreate -在创建新文档之前调用。
onAfterCreate -创建新文档后调用。
onBeforeRead - 在读取文档之前调用。
onAfterRead -读取文档后调用。
onBeforeUpdate - 在更新文档之前调用。
onAfterUpdate -更新文档后调用。
onBeforeDelete - 在删除文档之前调用。
onAfterDelete -删除文档后调用。

动态挂钩可以调用 -

函数，用 SQL、Javascript 或 OrientDB 和 JVM 支持的任何语言编写。
Java 静态方法。

类级别挂钩

类级别挂钩是为与类相关的所有文档定义的。以下是设置一个在类级别针对发票文档起作用的挂钩的示例。

CREATE CLASS Invoice EXTENDS OTriggered 
ALTER CLASS Invoice CUSTOM onAfterCreate = invoiceCreated

让我们在 Javascript 中创建函数voiceCreated，该函数在服务器控制台中打印创建的发票编号。

CREATE FUNCTION invoiceCreated "print('\\nInvoice created: ' + doc.field ('number'));"
LANGUAGE Javascript

现在通过创建一个新的发票文档来尝试挂钩。

INSERT INTO Invoice CONTENT {number: 100, notes: 'This is a test}

如果该命令执行成功，您将得到以下输出。

Invoice created: 100

文档级挂钩

您只能针对一个或多个文档定义特殊操作。为此，请允许您的类扩展OTriggered类。

例如，让我们针对现有的 Profile 类，针对属性 account = 'Premium' 的所有文档执行触发器（作为 Javascript 函数）。将调用触发器以防止删除文档。

ALTER CLASS Profile SUPERCLASS OTriggered UPDATE Profile 
SET onBeforeDelete = 'preventDeletion' WHERE account = 'Premium'

让我们创建PreventDeletion() Javascript 函数。

CREATE FUNCTION preventDeletion "throw new java.lang.RuntimeException('Cannot 
delete Premium profile ' + doc)" LANGUAGE Javascript

然后通过尝试删除“高级”帐户来测试挂钩。

DELETE FROM #12:1 
java.lang.RuntimeException: Cannot delete Premium profile
profile#12:1{onBeforeDelete:preventDeletion,account:Premium,name:Jill} v-1 
(<Unknown source>#2) in <Unknown source> at line number 2

JAVA钩子

OrientDB Hooks（触发器）的一个常见用例是管理任何或所有类的创建和更新日期。例如，您可以在每次创建记录时设置CreatedDate字段，并在每次更新记录时设置UpdatedDate字段，并且以这样的方式执行此操作：您在数据库层实现一次逻辑，而不必在数据库层再次担心它。应用层。

在创建之前，您必须通过访问以下链接下载orientdb-core.jar文件下载 OrientDB core。然后将该 jar 文件复制到要存储 Java 源文件的文件夹中。

创建挂钩文件

创建一个名为HookTest.java的 Java 文件，该文件将使用 Java 语言测试 Hook 机制。

import java.io.BufferedReader; 
import java.io.FileNotFoundException; 
import java.io.InputStream; 
import java.io.InputStreamReader; 
import java.io.StringReader; 
import java.util.ArrayList; 
import java.util.List; 
import java.util.concurrent.locks.ReentrantLock; 
import com.orientechnologies.orient.core.hook.ODocumentHookAbstract; 
import com.orientechnologies.orient.core.hook.ORecordHook; 
import com.orientechnologies.orient.core.hook.ORecordHookAbstract; 
import com.orientechnologies.orient.core.db.ODatabaseLifecycleListener; 
import com.orientechnologies.orient.core.db.ODatabase; 
import com.orientechnologies.orient.core.record.ORecord; 
import com.orientechnologies.orient.core.record.impl.ODocument;
  
public class HookTest extends ODocumentHookAbstract implements ORecordHook { 
   public HookTest() {
  
   }
  
   @Override 
   public DISTRIBUTED_EXECUTION_MODE getDistributedExecutionMode() { 
      return DISTRIBUTED_EXECUTION_MODE.BOTH; 
   } 
   public RESULT onRecordBeforeCreate( ODocument iDocument ) { 
      System.out.println("Ran create hook"); 
      return ORecordHook.RESULT.RECORD_NOT_CHANGED; 
   } 
   public RESULT onRecordBeforeUpdate( ODocument iDocument ) { 
      System.out.println("Ran update hook"); 
      return ORecordHook.RESULT.RECORD_NOT_CHANGED;  
   }  
}

每次创建或更新该类的记录时，上面的示例代码都会打印适当的注释。

让我们再添加一个钩子文件setCreatedUpdatedDates.java如下 -

import java.io.BufferedReader; 
import java.io.FileNotFoundException; 
import java.io.InputStream; 
import java.io.InputStreamReader; 
import java.io.StringReader; 
import java.util.ArrayList; 
import java.util.List; 
import java.util.concurrent.locks.ReentrantLock; 
import com.orientechnologies.orient.core.hook.ODocumentHookAbstract; 
import com.orientechnologies.orient.core.hook.ORecordHook; 
import com.orientechnologies.orient.core.hook.ORecordHookAbstract; 
import com.orientechnologies.orient.core.db.ODatabaseLifecycleListener; 
import com.orientechnologies.orient.core.db.ODatabase; 
import com.orientechnologies.orient.core.record.ORecord; 
import com.orientechnologies.orient.core.record.impl.ODocument; 
 
public class setCreatedUpdatedDates extends ODocumentHookAbstract implements ORecordHook { 
   public setCreatedUpdatedDates() { 
   
   }
   
   @Override 
   public DISTRIBUTED_EXECUTION_MODE getDistributedExecutionMode() { 
      return DISTRIBUTED_EXECUTION_MODE.BOTH; 
   } 
   public RESULT onRecordBeforeCreate( ODocument iDocument ) { 
      if ((iDocument.getClassName().charAt(0) == 't') || (iDocument.getClassName().charAt(0)=='r')) { 
         iDocument.field("CreatedDate", System.currentTimeMillis() / 1000l); 
         iDocument.field("UpdatedDate", System.currentTimeMillis() / 1000l); 
         return ORecordHook.RESULT.RECORD_CHANGED; 
      } else { 
         return ORecordHook.RESULT.RECORD_NOT_CHANGED; 
      } 
   } 
   
   public RESULT onRecordBeforeUpdate( ODocument iDocument ) { 
      if ((iDocument.getClassName().charAt(0) == 't') || (iDocument.getClassName().charAt(0)=='r')) { 
         iDocument.field("UpdatedDate", System.currentTimeMillis() / 1000l); 
         return ORecordHook.RESULT.RECORD_CHANGED; 
      } else { 
         return ORecordHook.RESULT.RECORD_NOT_CHANGED; 
      } 
   }  
}

上面的代码所做的是查找以字母“ r ”或“ t ”开头的任何类，并在创建记录时设置 CreatedDate 和 UpdatedDate，并在每次更新记录时设置 UpdatedDate。

编译 Java 钩子

使用以下命令编译 Java 代码。注意：将下载的 jar 文件和这些 Java 文件保存在同一文件夹中。

$ jar cf hooks-1.0-SNAPSHOT.jar *.java

将编译的代码移至 OrientDB Server 可以找到的位置

您需要将完成的 .jar 文件复制到 OrientDB 服务器将查找它们的目录。这意味着 OrientDB Server 根目录下的“ ./lib ”文件夹将如下所示 -

$ cp hooks-1.0-SNAPSHOT.jar "$ORIENTDB_HOME/lib"

在 OrientDB 服务器配置文件中启用测试挂钩

编辑$ORIENTDB_HOME/config/orientdb-server-config.xml并在文件末尾附近添加以下部分。

   <hooks> 
      <hook class = "HookTest" position = "REGULAR"/> 
   </hooks> 
   ... 
</orient-server>

重启OrientDB服务器

重新启动 OrientDB Server 后，您在orientdb-server-config.xml中定义的挂钩现在处于活动状态。启动 OrientDB 控制台，将其连接到您的数据库，然后运行以下命令 -

INSERT INTO V SET ID = 1;

如果该命令执行成功，您将得到以下输出。

Ran create hook

现在运行以下命令 -

UPDATE V SET ID = 2 WHERE ID = 1;

如果该命令执行成功，您将得到以下输出。

Ran update hook

在 OrientDB 服务器配置文件中启用 Real Hook

编辑$ORIENTDB_HOME/config/orientdb-server-config.xml并更改 hooks 部分，如下所示 -

   <hooks> 
      <hook class="setCreatedUpdatedDates" position="REGULAR"/> 
   </hooks> 
   ... 
</orient-server>

重启OrientDB服务器

创建一个以字母“ r ”或“ t ”开头的新类 -

CREATE CLASS tTest EXTENDS V;

现在插入一条记录 -

INSERT INTO tTest SET ID = 1 
SELECT FROM tTest

如果该命令执行成功，您将得到以下输出。

----+-----+------+----+-----------+----------- 
#   |@RID |@CLASS|ID  |CreatedDate|UpdatedDate 
----+-----+------+----+-----------+----------- 
0   |#19:0|tTest |1   |1427597275 |1427597275 
----+-----+------+----+-----------+-----------

即使您没有指定为CreatedDate和UpdatedDate设置的值，OrientDB 也会自动为您设置这些字段。

接下来，您需要使用以下命令更新记录 -

UPDATE tTest SET ID = 2 WHERE ID = 1; 
SELECT FROM tTest;

如果该命令执行成功，您将得到以下输出。

----+-----+------+----+-----------+----------- 
#   |@RID |@CLASS|ID  |CreatedDate|UpdatedDate 
----+-----+------+----+-----------+----------- 
0   |#19:0|tTest |2   |1427597275 |1427597306 
----+-----+------+----+-----------+-----------

您可以看到 OrientDB 更改了 UpdatedDate ，但让CreatedDate保持不变。

OrientDB Java Hooks 是一个非常有价值的工具，可以帮助自动化您原本必须在应用程序代码中完成的工作。由于许多 DBA 并不总是 Java 专家，因此希望本教程中包含的信息能让您抢占先机，让您对这项技术感到满意，使您能够在需要时成功创建数据库触发器。