Procedures

Fleet Manager provides a set of procedures to manage and monitor the connection to Aura. These procedures can be executed in Neo4j Browser or any other Neo4j client.

fleetManagement.debugLogging()
Admin Only

Table 1. Details
Syntax	`fleetManagement.debugLogging(debugLoggingEnabled, payloadLoggingEnabled) :: (result)`
Description	Enable debug or payload logging for Fleet Manager.
Input arguments	Name	Type	Description
	`debugLoggingEnabled`	`BOOLEAN`	Enable debug logging for fleet manager on this server.
	`payloadLoggingEnabled`	`BOOLEAN`	Enable payload logging for fleet manager on this server.
Return arguments	Name	Type	Description
Return arguments	`result`	`STRING`	A message indicating the result of the operation.
Mode	DBMS

fleetManagement.disable()
Admin Only

Table 2. Details
Syntax	`fleetManagement.disable() :: (result)`
Description	Disable Fleet Manager
Return arguments	Name	Type	Description
	`result`	`STRING`	A message indicating the result of the operation.
Mode	DBMS

fleetManagement.inspectToken()
Admin Only

Table 3. Details
Syntax	`fleetManagement.inspectToken([ token ]) :: (projectId, tokenExpires, errorMessage)`
Description	Inspect a Fleet Manager access token.
Input arguments	Name	Type	Description
Input arguments	`token`	`STRING`	(optional) A token obtained from Neo4j Aura. Will use the currently registered token, if not provided.
Return arguments	Name	Type	Description
	`projectId`	`STRING`	ID of the Aura project the Deployment token belongs to.
	`tokenExpires`	`STRING`	Token expiry
	`errorMessage`	`STRING`	Error message if token inspection fails.
Mode	DBMS

fleetManagement.registerToken()
Admin Only

Table 4. Details
Syntax	`fleetManagement.registerToken(token) :: (result)`
Description	Add a token for authenticating to Fleet Manager.
Input arguments	Name	Type	Description
Input arguments	`token`	`STRING`	A token obtained from Neo4j Aura.
Return arguments	Name	Type	Description
Return arguments	`result`	`STRING`	A message indicating the result of the operation.
Mode	DBMS

fleetManagement.reportedData()

Table 5. Details
Syntax	`fleetManagement.reportedData() :: (messageType, fieldPath, description, fieldType, values)`
Description	Generate documentation for the data structures used in Fleet Manager messages.
Return arguments	Name	Type	Description
	`messageType`	`STRING`	Name of the message in which the current field appears.
	`fieldPath`	`STRING`	The path to the field.
	`description`	`STRING`	Description of the field.
	`fieldType`	`STRING`	The data type of this field.
	`values`	`LIST<STRING>`	The current values of fields which are dynamically determined on connection.
Mode	READ

fleetManagement.restart()
Admin Only

Table 6. Details
Syntax	`fleetManagement.restart() :: (result)`
Description	Restart Fleet Manager.
Return arguments	Name	Type	Description
	`result`	`STRING`	A message indicating the result of the operation.
Mode	DBMS

fleetManagement.status()
Admin Only

Table 7. Details
Syntax	`fleetManagement.status() :: (active, connected, statusMessage)`
Description	Check the status of Fleet Manager.
Return arguments	Name	Type	Description
	`active`	`BOOLEAN`	Is Fleet Manager active?
	`connected`	`BOOLEAN`	Is Fleet Manager connected?
	`statusMessage`	`STRING`	Error message if Fleet Manager is not connected.
Mode	READ