user_defined_functions

Creates, updates, deletes, gets or lists a user_defined_functions resource.

Overview

Name	user_defined_functions
Type	Resource
Id	azure.confidential_ledger_dataplane.user_defined_functions

Fields

The following fields are returned by SELECT queries:

get_user_defined_function

Name	Datatype	Description
id	string	ID of the user defined function.
code	string	Code of the user defined function in JavaScript. Required.

list_user_defined_functions

Name	Datatype	Description
id	string	ID of the user defined function.
code	string	Code of the user defined function in JavaScript. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_user_defined_function	select	function_id, ledger_endpoint		Gets a user defined function. Returns the user defined function in the Confidential Ledger.
list_user_defined_functions	select	ledger_endpoint		Retrieves a list of user defined functions present in the Confidential Ledger. User defined functions stored in the Confidential Ledger.
create_user_defined_function	insert	function_id, ledger_endpoint, code		Creates a user defined function. Creates the user defined function in the Confidential Ledger.
delete_user_defined_function	delete	function_id, ledger_endpoint		Deletes a user defined function from the Confidential Ledger. Deletes a user defined function from the Confidential Ledger.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
function_id	string	Identifies a user defined function. Required.
ledger_endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client ledgerEndpoint parameter. (default: )

SELECT examples

get_user_defined_function

Gets a user defined function. Returns the user defined function in the Confidential Ledger.

SELECT
id,
code
FROM azure.confidential_ledger_dataplane.user_defined_functions
WHERE function_id = '{{ function_id }}' -- required
AND ledger_endpoint = '{{ ledger_endpoint }}' -- required
;

list_user_defined_functions

Retrieves a list of user defined functions present in the Confidential Ledger. User defined functions stored in the Confidential Ledger.

SELECT
id,
code
FROM azure.confidential_ledger_dataplane.user_defined_functions
WHERE ledger_endpoint = '{{ ledger_endpoint }}' -- required
;

INSERT examples

create_user_defined_function

Creates a user defined function. Creates the user defined function in the Confidential Ledger.

INSERT INTO azure.confidential_ledger_dataplane.user_defined_functions (
code,
function_id,
ledger_endpoint
)
SELECT 
'{{ code }}' /* required */,
'{{ function_id }}',
'{{ ledger_endpoint }}'
RETURNING
id,
code
;

Manifest

# Description fields are for documentation purposes
- name: user_defined_functions
props:
  - name: function_id
    value: "{{ function_id }}"
    description: Required parameter for the user_defined_functions resource.
  - name: ledger_endpoint
    value: "{{ ledger_endpoint }}"
    description: Required parameter for the user_defined_functions resource.
  - name: code
    value: "{{ code }}"
    description: |
      Code of the user defined function in JavaScript. Required.

DELETE examples

delete_user_defined_function

Deletes a user defined function from the Confidential Ledger. Deletes a user defined function from the Confidential Ledger.

DELETE FROM azure.confidential_ledger_dataplane.user_defined_functions
WHERE function_id = '{{ function_id }}' --required
AND ledger_endpoint = '{{ ledger_endpoint }}' --required
;