This provides a list of PGX API classes that require users to have permissions to be used.
Method | Required Permissions |
---|---|
compileProgram |
PGX_SESSION_COMPILE_ALGORITHM |
compileProgramCode |
PGX_SESSION_COMPILE_ALGORITHM |
createAnalyst |
-- |
createGraphBuilder |
-- |
createGraphFromFrames |
-- |
createMap |
-- |
createSequence |
-- |
createSet |
-- |
describeGraph |
if graph location is a file: READ on file-location that includes the file |
describeGraphFile |
READ on file-location that includes the file |
describeGraphFiles |
for each file: READ on file-location that includes the file |
explainPgql |
READ on the graph used in the query |
getAvailableCompiledProgramIds |
-- |
getAvailableSnapshots |
-- |
getCompiledProgram |
-- |
getExecutionEnvironment |
-- |
getGraph |
READ on the graph; if the graph is in the public namespace: SESSION_GET_PUBLISHED_GRAPH |
getGraphs |
-- |
getId |
-- |
getIdleTimeout |
-- |
getName |
-- |
getPgqlResultSet |
-- |
getServerInstance |
-- |
getSource |
-- |
getTaskTimeout |
-- |
preparePgql |
READ on the graph used in the query |
queryPgql |
READ on the graph used in the query |
readFrame |
-- |
readGraphAsOf |
PGX_SESSION_NEW_GRAPH ; for each file in the graph location: READ on file-location that includes the file |
readGraphFile |
PGX_SESSION_NEW_GRAPH ; READ on file-location that includes the file |
readGraphFiles |
PGX_SESSION_NEW_GRAPH ; for each file: READ on file-location that includes the file |
readGraphWithProperties |
PGX_SESSION_NEW_GRAPH ; for each file in the graph location: READ on file-location that includes the file |
registerKeystore |
-- |
runConcurrently |
-- |
setSnapshot |
-- |
Method | Required Permissions |
---|---|
addRedactionRule |
MANAGE |
alterGraph |
-- |
bipartiteSubGraphFromInDegree |
READ & PGX_SESSION_NEW_GRAPH |
bipartiteSubGraphFromLeftSet |
READ & PGX_SESSION_NEW_GRAPH |
clone |
READ & PGX_SESSION_NEW_GRAPH |
cloneAndExecutePgql |
READ & PGX_SESSION_NEW_GRAPH |
combineEdgePropertiesIntoVectorProperty |
READ |
combineVertexPropertiesIntoVectorProperty |
READ |
createAllPaths |
READ |
createChangeSet |
-- |
createComponents |
-- |
createEdgeProperty |
READ |
createEdgeSequence |
-- |
createEdgeSet |
-- |
createEdgeVectorProperty |
READ |
createMap |
-- |
createMergingStrategyBuilder |
-- |
createPath |
READ |
createPickingStrategyBuilder |
-- |
createScalar |
-- |
createVectorScalar |
-- |
createVertexProperty |
READ |
createVertexSequence |
-- |
createVertexSet |
-- |
createVertexVectorProperty |
READ |
destroy |
READ ; MANAGE if used with Retention.DESTROY_IF_NOT_USED |
destroyEdgePropertyIfExists |
READ |
destroyVertexPropertyIfExists |
READ |
executePgql |
READ |
explainPgql |
READ |
filter |
READ & PGX_SESSION_NEW_GRAPH |
getCollections |
-- |
getConfig |
READ |
getCreationRequestTimestamp |
READ |
getCreationTimestamp |
READ |
getDataSourceVersion |
READ |
getEdge |
READ |
getEdgeIdStrategy |
READ |
getEdgeLabel |
READ |
getEdgeProperties |
READ |
getEdgeProperty |
READ |
getEdges |
READ |
getId |
READ |
getMemoryMb |
READ |
getName |
READ |
getNumEdges |
READ |
getNumVertices |
READ |
getOrCreateEdgeProperty |
READ |
getOrCreateEdgeVectorProperty |
READ |
getOrCreateVertexProperty |
READ |
getOrCreateVertexVectorProperty |
READ |
getPgxInstance |
READ |
getRandomEdge |
READ |
getRandomVertex |
READ |
getRedactionRules |
MANAGE |
getSession |
-- |
getVertex |
READ |
getVertexIdStrategy |
READ |
getVertexIdType |
READ |
getVertexLabels |
READ |
getVertexProperties |
READ |
getVertexProperty |
READ |
getVertices |
READ |
grantPermission |
MANAGE |
hasEdge |
READ |
hasEdgeLabel |
READ |
hasVertex |
READ |
hasVertexLabels |
READ |
isBipartiteGraph |
READ |
isDirected |
READ |
isFresh |
READ |
isPublished |
READ |
isPublishedWithSnapshots |
READ |
isTransient |
READ |
preparePgql |
READ |
publish |
MANAGE & PGX_SESSION_ADD_PUBLISHED_GRAPH |
publishWithSnapshots |
MANAGE & PGX_SESSION_ADD_PUBLISHED_GRAPH |
queryPgql |
READ |
removeRedactionRule |
MANAGE |
rename |
MANAGE |
revokePermission |
MANAGE |
simplify |
READ & PGX_SESSION_NEW_GRAPH |
sortByDegree |
READ & PGX_SESSION_NEW_GRAPH |
sparsify |
READ & PGX_SESSION_NEW_GRAPH |
store |
EXPORT & WRITE on the file-location where the graph is being stored |
transpose |
READ & PGX_SESSION_NEW_GRAPH |
undirect |
READ & PGX_SESSION_NEW_GRAPH |
Method | Required Permissions |
---|---|
addEdge |
-- |
addVertex |
-- |
build |
PGX_SESSION_NEW_GRAPH |
getConfigParameter |
-- |
resetEdge |
-- |
resetVertex |
-- |
setConfigParameter |
-- |
setRetainEdgeIds |
-- |
setRetainIds |
-- |
setRetainVertexIds |
-- |
Method | Required Permissions |
---|---|
addEdgeProvider |
-- |
addVertexProvider |
-- |
build |
PGX_SESSION_NEW_GRAPH & READ on the source graph |
buildNewSnapshot |
PGX_SESSION_NEW_GRAPH & READ on the source graph |
cascadeEdgeProviderRemovals |
-- |
removeEdgeProvider |
-- |
removeVertexProvider |
-- |
Method | Required Permissions |
---|---|
addPinnedGraph |
PGX_SERVER_MANAGE |
addUserData |
PGX_SERVER_MANAGE |
demotePinnedGraph |
PGX_SERVER_MANAGE |
freeCachedMemory |
PGX_SERVER_MANAGE |
getExtendedVersion |
PGX_SERVER_GET_INFO |
getPgxConfig |
PGX_SERVER_GET_INFO |
getPgxConfigObject |
PGX_SERVER_GET_INFO |
getServerState |
PGX_SERVER_GET_INFO |
getUserData |
PGX_SERVER_GET_INFO |
getVersion |
-- |
isRunning |
-- |
joinMachine |
PGX_SERVER_MANAGE |
killSession |
PGX_SERVER_MANAGE |
resizePool |
PGX_SERVER_MANAGE |
shutdown |
PGX_SERVER_MANAGE |
shutdownNow |
PGX_SERVER_MANAGE |
shutdownNowIfRunning |
PGX_SERVER_MANAGE |
start |
PGX_SERVER_MANAGE |
updatePgxConfig |
PGX_SERVER_MANAGE |