Neo4j

實體、作業和動作

所有整合連接器都會為所連應用程式的物件提供抽象層。您只能透過這個抽象化程序存取應用程式的物件。抽象化會以實體、作業和動作的形式呈現。

• 實體： 實體可以視為已連結應用程式或服務中的物件，或是屬性集合。實體的定義因連接器而異。舉例來說，在資料庫連接器中，資料表是實體；在檔案伺服器連接器中，資料夾是實體；在訊息系統連接器中，佇列是實體。

  不過，連接器可能不支援或沒有任何實體，在這種情況下，Entities 清單會是空白。

• 作業： 作業是指您可以在實體上執行的活動。您可以對實體執行下列任一操作：
  • 列出
  • 取得
  • 建立
  • 更新
  • 刪除

  從可用清單中選取實體，系統會產生該實體可用的作業清單。如需作業的詳細說明，請參閱 Connectors 工作的實體作業。 不過，如果連接器不支援任何實體作業，系統就不會在 Operations 清單中列出這些不支援的作業。

• 動作： 動作是透過連接器介面提供給整合的第一類函式。動作可讓您變更一或多個實體，且因連接器而異。一般來說，動作會有一些輸入參數和輸出參數。不過，連接器可能不支援任何動作，此時 Actions 清單會是空白。

動作

本節列出連接器支援的操作。如要瞭解如何設定動作，請參閱「動作範例」。

ExecuteCustomQuery 動作

這項操作可讓您執行自訂查詢。

如要建立自訂查詢，請按照下列步驟操作：

1. 請按照詳細說明 新增連接器工作。
2. 設定連接器工作時，請在要執行的動作類型中選取「動作」。
3. 在「動作」清單中，選取「執行自訂查詢」，然後按一下「完成」。

   

4. 展開「Task input」(工作輸入) 區段，然後執行下列操作：
   1. 在「Timeout after」(逾時時間) 欄位中，輸入查詢執行前的等待秒數。

      預設值：180 秒。

   2. 在「資料列數量上限」欄位中，輸入要從資料庫傳回的資料列數量上限。

      預設值為 25。

   3. 如要更新自訂查詢，請按一下「編輯自訂指令碼」。「指令碼編輯器」對話方塊隨即開啟。

      

   4. 在「指令碼編輯器」對話方塊中輸入 SQL 查詢，然後按一下「儲存」。

      您可以在 SQL 陳述式中使用問號 (?) 代表單一參數，該參數必須在查詢參數清單中指定。舉例來說，下列 SQL 查詢會從 Employees 資料表選取與 LastName 資料欄指定值相符的所有資料列：

      SELECT * FROM Employees where LastName=?

   5. 如果您在 SQL 查詢中使用問號，請為每個問號點按「+ 新增參數名稱」，加入參數。執行整合時，這些參數會依序取代 SQL 查詢中的問號 (?)。舉例來說，如果您新增了三個問號 (?)，就必須依序新增三個參數。

      

      如要新增查詢參數，請按照下列步驟操作：

      1. 在「類型」清單中，選取參數的資料類型。
      2. 在「值」欄位中輸入參數值。
      3. 如要新增多個參數，請按一下「+ 新增查詢參數」。

執行成功後，這項動作會傳回狀態 200 (OK)，以及含有查詢結果的回應內容。

動作範例

本節說明如何在這個連接器中執行部分動作。

範例 - 建立節點

這個範例說明如何建立新節點。

1. 在 Configure Connector 對話方塊中，選取 Region, Connection, and Actions。
2. 從動作中選取 Execute Custom Query，然後按一下「完成」。
3. 在「Connector」(連接器) 的「Task Input」(任務輸入內容) 區段中，按一下 Edit Custom Script，然後在 Custom Query 欄位中輸入類似下列的值：

   CREATE (:Movie {title: 'Hey', release_year: 2010})

如果動作成功，Execute Custom Query 工作的 connectorOutputPayload 回應參數會提供空白的酬載 [ ]。

範例 - 更新節點

以下範例說明如何更新節點。

1. 在 Configure Connector 對話方塊中，選取 Region, Connection and Actions。
2. 從動作中選取 Execute Custom Query，然後按一下「完成」。
3. 在「Connector」(連接器) 的「Task Input」(任務輸入內容) 區段中，按一下 Edit Custom Script，然後在 Custom Query 欄位中輸入類似下列的值：

   match(m:Movie{title: 'Inception'}) set m.release_year=2011 return m

如果動作成功，Execute Custom Query 工作 connectorOutputPayload 回應參數值會類似於下列內容：

[{ "m": "{\"release_year\":2011,\"title\":\"Inception\"}" }]

範例 - 刪除節點

這個範例說明如何刪除節點。

1. 在 Configure Connector 對話方塊中，選取 Region, Connection and Actions。
2. 從動作中選取 Execute Custom Query，然後按一下「完成」。
3. 在「Connector」(連接器) 的「Task Input」(任務輸入內容) 區段中，按一下 Edit Custom Script，然後在 Custom Query 欄位中輸入類似下列的值：

   match(m:Movie{title: 'hey'}) delete m

如果動作成功，Execute Custom Query 工作的 connectorOutputPayload 回應參數會提供空白的酬載 [ ]。

範例 - 建立關係

以下範例說明如何建立關係。

1. 在 Configure Connector 對話方塊中，選取 Region, Connection and Actions。
2. 從動作中選取 Execute Custom Query，然後按一下「完成」。
3. 在「Connector」(連接器) 的「Task Input」(任務輸入內容) 區段中，按一下 Edit Custom Script，然後在 Custom Query 欄位中輸入類似下列的值：

   CREATE(movie:Movie {title: 'bcon'}), (actor:Actor {name: 'leo'})
   CREATE(actor)-[:ACTED_IN]->(movie)

如果動作成功，Execute Custom Query 工作的 connectorOutputPayload 回應參數會提供空白的酬載 [ ]。

範例 - 更新關係

以下範例說明如何更新關係。

1. 在 Configure Connector 對話方塊中，選取 Region, Connection and Actions。
2. 從動作中選取 Execute Custom Query，然後按一下「完成」。
3. 在「Connector」(連接器) 的「Task Input」(任務輸入內容) 區段中，按一下 Edit Custom Script，然後在 Custom Query 欄位中輸入類似下列的值：

   match(movie:Movie {title: 'demo'}), (actor:Actor {name: 'first'})
   match(actor)-[r:ACTED_IN]->(movie) set actor.name='second',r.year=2024 return actor,r,movie

如果動作成功，Execute Custom Query 工作 connectorOutputPayload 回應參數值會類似於下列內容：

[{   "actor": "{\"name\":\"second\"}",   "r": "{\"year\":2024}",   "movie": "{\"title\":\"demo\"}" }]

範例 - 刪除關係

這個範例說明如何刪除關係。

1. 在 Configure Connector 對話方塊中，選取 Region, Connection and Actions。
2. 從動作中選取 Execute Custom Query，然後按一下「完成」。
3. 在「Connector」(連接器) 的「Task Input」(任務輸入內容) 區段中，按一下 Edit Custom Script，然後在 Custom Query 欄位中輸入類似下列的值：

   MATCH(movie:Movie {title: 'bcon44'}), (actor:Actor {name: 'jacky'})
   MATCH(actor)-[r:ACTED_IN]->(movie) delete r

如果動作成功，Execute Custom Query 工作的 connectorOutputPayload 回應參數會提供空白的酬載 [ ]。

範例 - 更新節點標籤

本範例說明如何更新節點標籤。

1. 在 Configure Connector 對話方塊中，選取 Region, Connection and Actions。
2. 從動作中選取 Execute Custom Query，然後按一下「完成」。
3. 在「Connector」(連接器) 的「Task Input」(任務輸入內容) 區段中，按一下 Edit Custom Script，然後在 Custom Query 欄位中輸入類似下列的值：

   MATCH (n:Person) where id(n)=18 set n:Actor RETURN n

如果動作成功，Execute Custom Query 工作 connectorOutputPayload 回應參數值會類似於下列內容：

[{ "n": "{\"born\":1962,\"name\":\"Demi Moore\"}" }]

範例 - 更新關係類型

本例說明如何更新關係類型。

1. 在 Configure Connector 對話方塊中，選取 Region, Connection and Actions。
2. 從動作中選取 Execute Custom Query，然後按一下「完成」。
3. 在「Connector」(連接器) 的「Task Input」(任務輸入內容) 區段中，按一下 Edit Custom Script，然後在 Custom Query 欄位中輸入類似下列的值：

   MATCH (n:Person) where id(n)=18 set n.born=1963 RETURN n

如果動作成功，Execute Custom Query 工作 connectorOutputPayload 回應參數值會類似於下列內容：

[{ "n": "{\"born\":1963,\"name\":\"Demi Moore\"}" }]

範例 - 建立資料型別

這個範例說明如何建立資料型別。

1. 在 Configure Connector 對話方塊中，選取 Region, Connection and Actions。
2. 從動作中選取 Execute Custom Query，然後按一下「完成」。
3. 在「Connector」(連接器) 的「Task Input」(任務輸入內容) 區段中，按一下 Edit Custom Script，然後在 Custom Query 欄位中輸入類似下列的值：

   CREATE (:Product {unitPrice: 109.50,
   unitsInStock: 390,
   supplierID: "1",
   productID: "dumy-2",
   discontinued: false,
   quantityPerUnit: "10 boxes x 20 bags",
   productName: "productName-1",
   unitsOnOrder: 0,
   reorderLevel: 10,
   supplier: ["1"],
   expiry: Duration("P14DT18H12M"),
   categoryID: "1",
   updatedAt: DateTime("1984-11-11T12:31:14Z")})

如果動作成功，Execute Custom Query 工作的 connectorOutputPayload 回應參數會提供空白的酬載 [ ]。

範例 - 更新資料類型

這個範例說明如何更新資料型別。

1. 在 Configure Connector 對話方塊中，選取 Region, Connection and Actions。
2. 從動作中選取 Execute Custom Query，然後按一下「完成」。
3. 在「Connector」(連接器) 的「Task Input」(任務輸入內容) 區段中，按一下 Edit Custom Script，然後在 Custom Query 欄位中輸入類似下列的值：

   match(p:Product{productID: "dumy-1"}) set p.duration = Duration("P15DT19H12M"), p.updatedAt=DateTime("1984-11-12T12:31:14Z") return p

如果動作成功，Execute Custom Query 工作 connectorOutputPayload 回應參數值會類似於下列內容：

[{ "p": "{\"unitPrice\":109.5,
\"unitsInStock\":390,
\"supplierID\":\"1\",
\"productID\":\"dumy-1\",
\"discontinued\":false,
\"quantityPerUnit\":\"10 boxes x 20 bags\",
\"productName\":\"productName-1\",
\"unitsOnOrder\":0,
\"duration\":\"P15DT19H12M\",
\"reorderLevel\":10,
\"supplier\":[\"1\"],
\"expiry\":\"P14DT18H12M\",
\"categoryID\":\"1\",
\"updatedAt\":\"1984-11-12T12:31:14Z\"}" }, 
{ "p":"{\"unitPrice\":109.5,
\"unitsInStock\":390,
\"supplierID\":\"1\",
\"productID\":\"dumy-1\",
\"discontinued\":false,
\"quantityPerUnit\":\"10 boxes x 20 bags\",
\"productName\":\"productName-1\",
\"unitsOnOrder\":0,
\"duration\":\"P15DT19H12M\",
\"reorderLevel\":10,
\"supplier\":[\"1\"],
\"expiry\":\"P14DT18H12M\",
\"categoryID\":\"1\",
\"updatedAt\":\"1984-11-12T12:31:14Z\"}" }]

範例 - 刪除資料類型

這個範例說明如何刪除資料型別。

1. 在 Configure Connector 對話方塊中，選取 Region, Connection and Actions。
2. 從動作中選取 Execute Custom Query，然後按一下「完成」。
3. 在「Connector」(連接器) 的「Task Input」(任務輸入內容) 區段中，按一下 Edit Custom Script，然後在 Custom Query 欄位中輸入類似下列的值：

   match(p:Product{productID: "dumy-2"}) delete p

這個範例說明如何刪除資料型別。 如果動作成功，Execute Custom Query 工作的 connectorOutputPayload 回應參數會提供空白的酬載 [ ]。

範例 - 取得節點數量

這個範例說明如何取得節點數量。

1. 在 Configure Connector 對話方塊中，選取 Region, Connection and Actions。
2. 從動作中選取 Execute Custom Query，然後按一下「完成」。
3. 在「Connector」(連接器) 的「Task Input」(任務輸入內容) 區段中，按一下 Edit Custom Script，然後在 Custom Query 欄位中輸入類似下列的值：

   MATCH ()  
   RETURN count(*) AS numNodes

如果動作成功，Execute Custom Query 工作的 connectorOutputPayload 回應參數會提供類似下列內容的酬載：

[{
  "numNodes": 6267.0
}]

實體作業範例

本節說明如何使用這個連接器執行部分實體作業。

範例 - 列出所有語言

這個範例說明如何列出所有語言。

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 multilanguage_table。
3. 選取「List」作業，然後按一下「完成」。
4. 在「資料對應器」部分中，按一下「開啟資料對應編輯器」，然後根據需求設定 filterClause。

範例 - 取得語言

這個範例說明如何取得語言。

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 multilanguage_table。
3. 選取「Get」作業，然後按一下「完成」。
4. 將實體 ID 設為「取得單一語言」。如要設定實體 ID，請在「資料對應器」部分點選「開啟資料對應編輯器」，然後在「輸入值」欄位中輸入 58.0，並選擇「entityId」做為本機變數。