@robosystems/client 0.2.13 → 0.2.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/extensions/TableIngestClient.js +5 -4
- package/extensions/TableIngestClient.ts +8 -7
- package/package.json +1 -1
- package/sdk/sdk.gen.d.ts +401 -228
- package/sdk/sdk.gen.js +486 -257
- package/sdk/sdk.gen.ts +480 -251
- package/sdk/types.gen.d.ts +708 -250
- package/sdk/types.gen.ts +747 -264
- package/sdk-extensions/TableIngestClient.js +5 -4
- package/sdk-extensions/TableIngestClient.ts +8 -7
- package/sdk.gen.d.ts +401 -228
- package/sdk.gen.js +486 -257
- package/sdk.gen.ts +480 -251
- package/types.gen.d.ts +708 -250
- package/types.gen.ts +747 -264
package/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Options as ClientOptions, TDataShape, Client } from './client';
|
|
2
|
-
import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshAuthSessionData, RefreshAuthSessionResponses, RefreshAuthSessionErrors, ResendVerificationEmailData, ResendVerificationEmailResponses, ResendVerificationEmailErrors, VerifyEmailData, VerifyEmailResponses, VerifyEmailErrors, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ForgotPasswordData, ForgotPasswordResponses, ForgotPasswordErrors, ValidateResetTokenData, ValidateResetTokenResponses, ValidateResetTokenErrors, ResetPasswordData, ResetPasswordResponses, ResetPasswordErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, GetServiceStatusData, GetServiceStatusResponses, GetCurrentUserData, GetCurrentUserResponses, UpdateUserData, UpdateUserResponses, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordResponses, UpdateUserPasswordErrors, ListUserApiKeysData, ListUserApiKeysResponses, CreateUserApiKeyData, CreateUserApiKeyResponses, CreateUserApiKeyErrors, RevokeUserApiKeyData, RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, UpdateUserApiKeyData, UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, ListUserOrgsData, ListUserOrgsResponses, CreateOrgData, CreateOrgResponses, CreateOrgErrors, GetOrgData, GetOrgResponses, GetOrgErrors, UpdateOrgData, UpdateOrgResponses, UpdateOrgErrors, ListOrgGraphsData, ListOrgGraphsResponses, ListOrgGraphsErrors, ListOrgMembersData, ListOrgMembersResponses, ListOrgMembersErrors, InviteOrgMemberData, InviteOrgMemberResponses, InviteOrgMemberErrors, RemoveOrgMemberData, RemoveOrgMemberResponses, RemoveOrgMemberErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleResponses, UpdateOrgMemberRoleErrors, GetOrgLimitsData, GetOrgLimitsResponses, GetOrgLimitsErrors, GetOrgUsageData, GetOrgUsageResponses, GetOrgUsageErrors, ListConnectionsData, ListConnectionsResponses, ListConnectionsErrors, CreateConnectionData, CreateConnectionResponses, CreateConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsResponses, GetConnectionOptionsErrors, ExchangeLinkTokenData, ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, CreateLinkTokenData, CreateLinkTokenResponses, CreateLinkTokenErrors, InitOAuthData, InitOAuthResponses, InitOAuthErrors, OauthCallbackData, OauthCallbackResponses, OauthCallbackErrors, DeleteConnectionData, DeleteConnectionResponses, DeleteConnectionErrors, GetConnectionData, GetConnectionResponses, GetConnectionErrors, SyncConnectionData, SyncConnectionResponses, SyncConnectionErrors, ListAgentsData, ListAgentsResponses, ListAgentsErrors, AutoSelectAgentData, AutoSelectAgentResponses, AutoSelectAgentErrors, GetAgentMetadataData, GetAgentMetadataResponses, GetAgentMetadataErrors, ExecuteSpecificAgentData, ExecuteSpecificAgentResponses, ExecuteSpecificAgentErrors, BatchProcessQueriesData, BatchProcessQueriesResponses, BatchProcessQueriesErrors, RecommendAgentData, RecommendAgentResponses, RecommendAgentErrors, ListMcpToolsData, ListMcpToolsResponses, ListMcpToolsErrors, CallMcpToolData, CallMcpToolResponses, CallMcpToolErrors, ListBackupsData, ListBackupsResponses, ListBackupsErrors, CreateBackupData, CreateBackupResponses, CreateBackupErrors, GetBackupDownloadUrlData, GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, RestoreBackupData, RestoreBackupResponses, RestoreBackupErrors, GetBackupStatsData, GetBackupStatsResponses, GetBackupStatsErrors, GetGraphMetricsData, GetGraphMetricsResponses, GetGraphMetricsErrors, GetGraphUsageAnalyticsData, GetGraphUsageAnalyticsResponses, GetGraphUsageAnalyticsErrors, ExecuteCypherQueryData, ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, GetGraphSchemaData, GetGraphSchemaResponses, GetGraphSchemaErrors, ExportGraphSchemaData, ExportGraphSchemaResponses, ExportGraphSchemaErrors, ValidateSchemaData, ValidateSchemaResponses, ValidateSchemaErrors, GetCreditSummaryData, GetCreditSummaryResponses, GetCreditSummaryErrors, ListCreditTransactionsData, ListCreditTransactionsResponses, ListCreditTransactionsErrors, CheckCreditBalanceData, CheckCreditBalanceResponses, CheckCreditBalanceErrors, GetStorageUsageData, GetStorageUsageResponses, GetStorageUsageErrors, CheckStorageLimitsData, CheckStorageLimitsResponses, CheckStorageLimitsErrors, GetDatabaseHealthData, GetDatabaseHealthResponses, GetDatabaseHealthErrors, GetDatabaseInfoData, GetDatabaseInfoResponses, GetDatabaseInfoErrors, GetGraphLimitsData, GetGraphLimitsResponses, GetGraphLimitsErrors, ListSubgraphsData, ListSubgraphsResponses, ListSubgraphsErrors, CreateSubgraphData, CreateSubgraphResponses, CreateSubgraphErrors, DeleteSubgraphData, DeleteSubgraphResponses, DeleteSubgraphErrors, GetSubgraphInfoData, GetSubgraphInfoResponses, GetSubgraphInfoErrors, GetSubgraphQuotaData, GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, GetGraphSubscriptionData, GetGraphSubscriptionResponses, GetGraphSubscriptionErrors, CreateRepositorySubscriptionData, CreateRepositorySubscriptionResponses, CreateRepositorySubscriptionErrors, UpgradeSubscriptionData, UpgradeSubscriptionResponses, UpgradeSubscriptionErrors, ListTablesData, ListTablesResponses, ListTablesErrors,
|
|
2
|
+
import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshAuthSessionData, RefreshAuthSessionResponses, RefreshAuthSessionErrors, ResendVerificationEmailData, ResendVerificationEmailResponses, ResendVerificationEmailErrors, VerifyEmailData, VerifyEmailResponses, VerifyEmailErrors, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ForgotPasswordData, ForgotPasswordResponses, ForgotPasswordErrors, ValidateResetTokenData, ValidateResetTokenResponses, ValidateResetTokenErrors, ResetPasswordData, ResetPasswordResponses, ResetPasswordErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, GetServiceStatusData, GetServiceStatusResponses, GetCurrentUserData, GetCurrentUserResponses, UpdateUserData, UpdateUserResponses, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordResponses, UpdateUserPasswordErrors, ListUserApiKeysData, ListUserApiKeysResponses, CreateUserApiKeyData, CreateUserApiKeyResponses, CreateUserApiKeyErrors, RevokeUserApiKeyData, RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, UpdateUserApiKeyData, UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, ListUserOrgsData, ListUserOrgsResponses, CreateOrgData, CreateOrgResponses, CreateOrgErrors, GetOrgData, GetOrgResponses, GetOrgErrors, UpdateOrgData, UpdateOrgResponses, UpdateOrgErrors, ListOrgGraphsData, ListOrgGraphsResponses, ListOrgGraphsErrors, ListOrgMembersData, ListOrgMembersResponses, ListOrgMembersErrors, InviteOrgMemberData, InviteOrgMemberResponses, InviteOrgMemberErrors, RemoveOrgMemberData, RemoveOrgMemberResponses, RemoveOrgMemberErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleResponses, UpdateOrgMemberRoleErrors, GetOrgLimitsData, GetOrgLimitsResponses, GetOrgLimitsErrors, GetOrgUsageData, GetOrgUsageResponses, GetOrgUsageErrors, ListConnectionsData, ListConnectionsResponses, ListConnectionsErrors, CreateConnectionData, CreateConnectionResponses, CreateConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsResponses, GetConnectionOptionsErrors, ExchangeLinkTokenData, ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, CreateLinkTokenData, CreateLinkTokenResponses, CreateLinkTokenErrors, InitOAuthData, InitOAuthResponses, InitOAuthErrors, OauthCallbackData, OauthCallbackResponses, OauthCallbackErrors, DeleteConnectionData, DeleteConnectionResponses, DeleteConnectionErrors, GetConnectionData, GetConnectionResponses, GetConnectionErrors, SyncConnectionData, SyncConnectionResponses, SyncConnectionErrors, ListAgentsData, ListAgentsResponses, ListAgentsErrors, AutoSelectAgentData, AutoSelectAgentResponses, AutoSelectAgentErrors, GetAgentMetadataData, GetAgentMetadataResponses, GetAgentMetadataErrors, ExecuteSpecificAgentData, ExecuteSpecificAgentResponses, ExecuteSpecificAgentErrors, BatchProcessQueriesData, BatchProcessQueriesResponses, BatchProcessQueriesErrors, RecommendAgentData, RecommendAgentResponses, RecommendAgentErrors, ListMcpToolsData, ListMcpToolsResponses, ListMcpToolsErrors, CallMcpToolData, CallMcpToolResponses, CallMcpToolErrors, ListBackupsData, ListBackupsResponses, ListBackupsErrors, CreateBackupData, CreateBackupResponses, CreateBackupErrors, GetBackupDownloadUrlData, GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, RestoreBackupData, RestoreBackupResponses, RestoreBackupErrors, GetBackupStatsData, GetBackupStatsResponses, GetBackupStatsErrors, GetGraphMetricsData, GetGraphMetricsResponses, GetGraphMetricsErrors, GetGraphUsageAnalyticsData, GetGraphUsageAnalyticsResponses, GetGraphUsageAnalyticsErrors, ExecuteCypherQueryData, ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, GetGraphSchemaData, GetGraphSchemaResponses, GetGraphSchemaErrors, ExportGraphSchemaData, ExportGraphSchemaResponses, ExportGraphSchemaErrors, ValidateSchemaData, ValidateSchemaResponses, ValidateSchemaErrors, GetCreditSummaryData, GetCreditSummaryResponses, GetCreditSummaryErrors, ListCreditTransactionsData, ListCreditTransactionsResponses, ListCreditTransactionsErrors, CheckCreditBalanceData, CheckCreditBalanceResponses, CheckCreditBalanceErrors, GetStorageUsageData, GetStorageUsageResponses, GetStorageUsageErrors, CheckStorageLimitsData, CheckStorageLimitsResponses, CheckStorageLimitsErrors, GetDatabaseHealthData, GetDatabaseHealthResponses, GetDatabaseHealthErrors, GetDatabaseInfoData, GetDatabaseInfoResponses, GetDatabaseInfoErrors, GetGraphLimitsData, GetGraphLimitsResponses, GetGraphLimitsErrors, ListSubgraphsData, ListSubgraphsResponses, ListSubgraphsErrors, CreateSubgraphData, CreateSubgraphResponses, CreateSubgraphErrors, DeleteSubgraphData, DeleteSubgraphResponses, DeleteSubgraphErrors, GetSubgraphInfoData, GetSubgraphInfoResponses, GetSubgraphInfoErrors, GetSubgraphQuotaData, GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, GetGraphSubscriptionData, GetGraphSubscriptionResponses, GetGraphSubscriptionErrors, CreateRepositorySubscriptionData, CreateRepositorySubscriptionResponses, CreateRepositorySubscriptionErrors, UpgradeSubscriptionData, UpgradeSubscriptionResponses, UpgradeSubscriptionErrors, ListTablesData, ListTablesResponses, ListTablesErrors, QueryTablesData, QueryTablesResponses, QueryTablesErrors, CreateViewData, CreateViewResponses, CreateViewErrors, SaveViewData, SaveViewResponses, SaveViewErrors, GetMaterializationStatusData, GetMaterializationStatusResponses, GetMaterializationStatusErrors, MaterializeGraphData, MaterializeGraphResponses, MaterializeGraphErrors, ListFilesData, ListFilesResponses, ListFilesErrors, CreateFileUploadData, CreateFileUploadResponses, CreateFileUploadErrors, DeleteFileData, DeleteFileResponses, DeleteFileErrors, GetFileData, GetFileResponses, GetFileErrors, UpdateFileData, UpdateFileResponses, UpdateFileErrors, GetGraphsData, GetGraphsResponses, GetGraphsErrors, CreateGraphData, CreateGraphResponses, CreateGraphErrors, GetAvailableExtensionsData, GetAvailableExtensionsResponses, GetAvailableExtensionsErrors, GetAvailableGraphTiersData, GetAvailableGraphTiersResponses, GetAvailableGraphTiersErrors, SelectGraphData, SelectGraphResponses, SelectGraphErrors, GetServiceOfferingsData, GetServiceOfferingsResponses, GetServiceOfferingsErrors, StreamOperationEventsData, StreamOperationEventsResponses, StreamOperationEventsErrors, GetOperationStatusData, GetOperationStatusResponses, GetOperationStatusErrors, CancelOperationData, CancelOperationResponses, CancelOperationErrors, GetOrgBillingCustomerData, GetOrgBillingCustomerResponses, GetOrgBillingCustomerErrors, CreatePortalSessionData, CreatePortalSessionResponses, CreatePortalSessionErrors, ListOrgSubscriptionsData, ListOrgSubscriptionsResponses, ListOrgSubscriptionsErrors, GetOrgSubscriptionData, GetOrgSubscriptionResponses, GetOrgSubscriptionErrors, CancelOrgSubscriptionData, CancelOrgSubscriptionResponses, CancelOrgSubscriptionErrors, ListOrgInvoicesData, ListOrgInvoicesResponses, ListOrgInvoicesErrors, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceResponses, GetOrgUpcomingInvoiceErrors, CreateCheckoutSessionData, CreateCheckoutSessionResponses, CreateCheckoutSessionErrors, GetCheckoutStatusData, GetCheckoutStatusResponses, GetCheckoutStatusErrors } from './types.gen';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -457,6 +457,13 @@ export declare const listAgents: <ThrowOnError extends boolean = false>(options:
|
|
|
457
457
|
* - Leverage conversation history for contextual understanding
|
|
458
458
|
* - Enable RAG for knowledge base enrichment
|
|
459
459
|
*
|
|
460
|
+
* **Subgraph Support:**
|
|
461
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
462
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
463
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
464
|
+
* Agents operate on the specified graph/subgraph's data independently. RAG enrichment
|
|
465
|
+
* and knowledge base search are scoped to the specific graph/subgraph.
|
|
466
|
+
*
|
|
460
467
|
* See request/response examples in the "Examples" dropdown below.
|
|
461
468
|
*/
|
|
462
469
|
export declare const autoSelectAgent: <ThrowOnError extends boolean = false>(options: Options<AutoSelectAgentData, ThrowOnError>) => import("./client").RequestResult<AutoSelectAgentResponses, AutoSelectAgentErrors, ThrowOnError, "fields">;
|
|
@@ -545,6 +552,13 @@ export declare const recommendAgent: <ThrowOnError extends boolean = false>(opti
|
|
|
545
552
|
* - User permissions and subscription tier
|
|
546
553
|
* - Backend capabilities (Kuzu, Neo4j, etc.)
|
|
547
554
|
*
|
|
555
|
+
* **Subgraph Support:**
|
|
556
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
557
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
558
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
559
|
+
* The returned tool list is identical for parent graphs and subgraphs, as all
|
|
560
|
+
* MCP tools work uniformly across graph boundaries.
|
|
561
|
+
*
|
|
548
562
|
* **Note:**
|
|
549
563
|
* MCP tool listing is included - no credit consumption required.
|
|
550
564
|
*/
|
|
@@ -583,6 +597,13 @@ export declare const listMcpTools: <ThrowOnError extends boolean = false>(option
|
|
|
583
597
|
* - `408 Request Timeout`: Tool execution exceeded timeout
|
|
584
598
|
* - Clients should implement exponential backoff on errors
|
|
585
599
|
*
|
|
600
|
+
* **Subgraph Support:**
|
|
601
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
602
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
603
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
604
|
+
* MCP tools operate on the specified graph/subgraph independently. Each subgraph
|
|
605
|
+
* has its own schema, data, and can be queried separately via MCP.
|
|
606
|
+
*
|
|
586
607
|
* **Credit Model:**
|
|
587
608
|
* MCP tool execution is included - no credit consumption required. Database
|
|
588
609
|
* operations (queries, schema inspection, analytics) are completely free.
|
|
@@ -793,11 +814,14 @@ export declare const getGraphMetrics: <ThrowOnError extends boolean = false>(opt
|
|
|
793
814
|
*/
|
|
794
815
|
export declare const getGraphUsageAnalytics: <ThrowOnError extends boolean = false>(options: Options<GetGraphUsageAnalyticsData, ThrowOnError>) => import("./client").RequestResult<GetGraphUsageAnalyticsResponses, GetGraphUsageAnalyticsErrors, ThrowOnError, "fields">;
|
|
795
816
|
/**
|
|
796
|
-
* Execute Cypher Query
|
|
797
|
-
* Execute a
|
|
817
|
+
* Execute Cypher Query
|
|
818
|
+
* Execute a Cypher query with intelligent response optimization.
|
|
819
|
+
*
|
|
820
|
+
* **IMPORTANT: Write operations depend on graph type:**
|
|
821
|
+
* - **Main Graphs**: READ-ONLY. Write operations (CREATE, MERGE, SET, DELETE) are not allowed.
|
|
822
|
+
* - **Subgraphs**: WRITE-ENABLED. Full Cypher write operations are supported for development and report creation.
|
|
798
823
|
*
|
|
799
|
-
*
|
|
800
|
-
* To load data into your graph, use the staging pipeline:
|
|
824
|
+
* To load data into main graphs, use the staging pipeline:
|
|
801
825
|
* 1. Create file upload: `POST /v1/graphs/{graph_id}/tables/{table_name}/files`
|
|
802
826
|
* 2. Ingest to graph: `POST /v1/graphs/{graph_id}/tables/ingest`
|
|
803
827
|
*
|
|
@@ -850,6 +874,12 @@ export declare const getGraphUsageAnalytics: <ThrowOnError extends boolean = fal
|
|
|
850
874
|
* - `503 Service Unavailable`: Circuit breaker open or SSE disabled
|
|
851
875
|
* - Clients should implement exponential backoff
|
|
852
876
|
*
|
|
877
|
+
* **Subgraph Support:**
|
|
878
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
879
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
880
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
881
|
+
* Subgraphs share the same instance as their parent graph and have independent data.
|
|
882
|
+
*
|
|
853
883
|
* **Note:**
|
|
854
884
|
* Query operations are included - no credit consumption required.
|
|
855
885
|
* Queue position is based on subscription tier for priority.
|
|
@@ -892,6 +922,14 @@ export declare const executeCypherQuery: <ThrowOnError extends boolean = false>(
|
|
|
892
922
|
* Property discovery is limited to 10 properties per node type for performance.
|
|
893
923
|
* For complete schema definitions, use `/schema/export`.
|
|
894
924
|
*
|
|
925
|
+
* ## Subgraph Support
|
|
926
|
+
*
|
|
927
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
928
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
929
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
930
|
+
* Each subgraph has independent schema and data. The returned schema reflects
|
|
931
|
+
* only the specified graph/subgraph's actual structure.
|
|
932
|
+
*
|
|
895
933
|
* This operation is included - no credit consumption required.
|
|
896
934
|
*/
|
|
897
935
|
export declare const getGraphSchema: <ThrowOnError extends boolean = false>(options: Options<GetGraphSchemaData, ThrowOnError>) => import("./client").RequestResult<GetGraphSchemaResponses, GetGraphSchemaErrors, ThrowOnError, "fields">;
|
|
@@ -969,6 +1007,13 @@ export declare const exportGraphSchema: <ThrowOnError extends boolean = false>(o
|
|
|
969
1007
|
* - Performance problems
|
|
970
1008
|
* - Naming conflicts
|
|
971
1009
|
*
|
|
1010
|
+
* **Subgraph Support:**
|
|
1011
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1012
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1013
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1014
|
+
* Schema validation is performed against the specified graph/subgraph's current
|
|
1015
|
+
* schema and data structure.
|
|
1016
|
+
*
|
|
972
1017
|
* This operation is included - no credit consumption required.
|
|
973
1018
|
*/
|
|
974
1019
|
export declare const validateSchema: <ThrowOnError extends boolean = false>(options: Options<ValidateSchemaData, ThrowOnError>) => import("./client").RequestResult<ValidateSchemaResponses, ValidateSchemaErrors, ThrowOnError, "fields">;
|
|
@@ -1065,6 +1110,13 @@ export declare const checkStorageLimits: <ThrowOnError extends boolean = false>(
|
|
|
1065
1110
|
* - **Resource Usage**: Memory and storage consumption
|
|
1066
1111
|
* - **Alerts**: Active warnings or issues
|
|
1067
1112
|
*
|
|
1113
|
+
* **Subgraph Support:**
|
|
1114
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1115
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1116
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1117
|
+
* Health metrics are specific to the requested graph/subgraph. Subgraphs share the
|
|
1118
|
+
* same physical instance as their parent but have independent health indicators.
|
|
1119
|
+
*
|
|
1068
1120
|
* This endpoint provides essential monitoring data for operational visibility.
|
|
1069
1121
|
*/
|
|
1070
1122
|
export declare const getDatabaseHealth: <ThrowOnError extends boolean = false>(options: Options<GetDatabaseHealthData, ThrowOnError>) => import("./client").RequestResult<GetDatabaseHealthResponses, GetDatabaseHealthErrors, ThrowOnError, "fields">;
|
|
@@ -1087,6 +1139,13 @@ export declare const getDatabaseHealth: <ThrowOnError extends boolean = false>(o
|
|
|
1087
1139
|
* - **Backup Status**: Backup availability and recency
|
|
1088
1140
|
* - **Timestamps**: Creation and modification dates
|
|
1089
1141
|
*
|
|
1142
|
+
* **Subgraph Support:**
|
|
1143
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1144
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1145
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1146
|
+
* Returned metrics are specific to the requested graph/subgraph. Subgraphs have
|
|
1147
|
+
* independent size, node/relationship counts, and backup status.
|
|
1148
|
+
*
|
|
1090
1149
|
* This endpoint provides essential database information for capacity planning and monitoring.
|
|
1091
1150
|
*/
|
|
1092
1151
|
export declare const getDatabaseInfo: <ThrowOnError extends boolean = false>(options: Options<GetDatabaseInfoData, ThrowOnError>) => import("./client").RequestResult<GetDatabaseInfoResponses, GetDatabaseInfoErrors, ThrowOnError, "fields">;
|
|
@@ -1104,7 +1163,7 @@ export declare const getDatabaseInfo: <ThrowOnError extends boolean = false>(opt
|
|
|
1104
1163
|
*
|
|
1105
1164
|
* This unified endpoint provides all limits in one place for easier client integration.
|
|
1106
1165
|
*
|
|
1107
|
-
* **Note**: Limits vary based on subscription tier (
|
|
1166
|
+
* **Note**: Limits vary based on subscription tier (kuzu-standard, kuzu-large, kuzu-xlarge).
|
|
1108
1167
|
*/
|
|
1109
1168
|
export declare const getGraphLimits: <ThrowOnError extends boolean = false>(options: Options<GetGraphLimitsData, ThrowOnError>) => import("./client").RequestResult<GetGraphLimitsResponses, GetGraphLimitsErrors, ThrowOnError, "fields">;
|
|
1110
1169
|
/**
|
|
@@ -1123,7 +1182,7 @@ export declare const getGraphLimits: <ThrowOnError extends boolean = false>(opti
|
|
|
1123
1182
|
export declare const listSubgraphs: <ThrowOnError extends boolean = false>(options: Options<ListSubgraphsData, ThrowOnError>) => import("./client").RequestResult<ListSubgraphsResponses, ListSubgraphsErrors, ThrowOnError, "fields">;
|
|
1124
1183
|
/**
|
|
1125
1184
|
* Create Subgraph
|
|
1126
|
-
* Create a new subgraph within a parent graph.
|
|
1185
|
+
* Create a new subgraph within a parent graph, with optional data forking.
|
|
1127
1186
|
*
|
|
1128
1187
|
* **Requirements:**
|
|
1129
1188
|
* - Valid authentication
|
|
@@ -1133,8 +1192,23 @@ export declare const listSubgraphs: <ThrowOnError extends boolean = false>(optio
|
|
|
1133
1192
|
* - Must be within subgraph quota limits
|
|
1134
1193
|
* - Subgraph name must be unique within the parent graph
|
|
1135
1194
|
*
|
|
1195
|
+
* **Fork Mode:**
|
|
1196
|
+
* When `fork_parent=true`, the operation:
|
|
1197
|
+
* - Returns immediately with an operation_id for SSE monitoring
|
|
1198
|
+
* - Copies data from parent graph to the new subgraph
|
|
1199
|
+
* - Supports selective forking via metadata.fork_options
|
|
1200
|
+
* - Tracks progress in real-time via SSE
|
|
1201
|
+
*
|
|
1136
1202
|
* **Returns:**
|
|
1137
|
-
* -
|
|
1203
|
+
* - Without fork: Immediate SubgraphResponse with created subgraph details
|
|
1204
|
+
* - With fork: Operation response with SSE monitoring endpoint
|
|
1205
|
+
*
|
|
1206
|
+
* **Subgraph ID format:** `{parent_id}_{subgraph_name}` (e.g., kg1234567890abcdef_dev)
|
|
1207
|
+
*
|
|
1208
|
+
* **Usage:**
|
|
1209
|
+
* - Subgraphs share parent's credit pool
|
|
1210
|
+
* - Subgraph ID can be used in all standard `/v1/graphs/{graph_id}*` endpoints
|
|
1211
|
+
* - Permissions inherited from parent graph
|
|
1138
1212
|
*/
|
|
1139
1213
|
export declare const createSubgraph: <ThrowOnError extends boolean = false>(options: Options<CreateSubgraphData, ThrowOnError>) => import("./client").RequestResult<CreateSubgraphResponses, CreateSubgraphErrors, ThrowOnError, "fields">;
|
|
1140
1214
|
/**
|
|
@@ -1144,6 +1218,7 @@ export declare const createSubgraph: <ThrowOnError extends boolean = false>(opti
|
|
|
1144
1218
|
* **Requirements:**
|
|
1145
1219
|
* - Must be a valid subgraph (not parent graph)
|
|
1146
1220
|
* - User must have admin access to parent graph
|
|
1221
|
+
* - Subgraph name must be alphanumeric (1-20 characters)
|
|
1147
1222
|
* - Optional backup before deletion
|
|
1148
1223
|
*
|
|
1149
1224
|
* **Deletion Options:**
|
|
@@ -1157,6 +1232,11 @@ export declare const createSubgraph: <ThrowOnError extends boolean = false>(opti
|
|
|
1157
1232
|
* **Backup Location:**
|
|
1158
1233
|
* If backup requested, stored in S3 Kuzu database bucket at:
|
|
1159
1234
|
* `s3://{kuzu_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
|
|
1235
|
+
*
|
|
1236
|
+
* **Notes:**
|
|
1237
|
+
* - Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
|
|
1238
|
+
* - Deletion does not affect parent graph's credit pool or permissions
|
|
1239
|
+
* - Backup creation consumes credits from parent graph's allocation
|
|
1160
1240
|
*/
|
|
1161
1241
|
export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(options: Options<DeleteSubgraphData, ThrowOnError>) => import("./client").RequestResult<DeleteSubgraphResponses, DeleteSubgraphErrors, ThrowOnError, "fields">;
|
|
1162
1242
|
/**
|
|
@@ -1165,6 +1245,7 @@ export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(opti
|
|
|
1165
1245
|
*
|
|
1166
1246
|
* **Requirements:**
|
|
1167
1247
|
* - User must have read access to parent graph
|
|
1248
|
+
* - Subgraph name must be alphanumeric (1-20 characters)
|
|
1168
1249
|
*
|
|
1169
1250
|
* **Response includes:**
|
|
1170
1251
|
* - Full subgraph metadata
|
|
@@ -1180,6 +1261,10 @@ export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(opti
|
|
|
1180
1261
|
* - Edge count
|
|
1181
1262
|
* - Database size on disk
|
|
1182
1263
|
* - Schema information
|
|
1264
|
+
*
|
|
1265
|
+
* **Note:**
|
|
1266
|
+
* Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID.
|
|
1267
|
+
* The full ID is returned in the response (e.g., 'kg0123456789abcdef_dev').
|
|
1183
1268
|
*/
|
|
1184
1269
|
export declare const getSubgraphInfo: <ThrowOnError extends boolean = false>(options: Options<GetSubgraphInfoData, ThrowOnError>) => import("./client").RequestResult<GetSubgraphInfoResponses, GetSubgraphInfoErrors, ThrowOnError, "fields">;
|
|
1185
1270
|
/**
|
|
@@ -1270,287 +1355,375 @@ export declare const upgradeSubscription: <ThrowOnError extends boolean = false>
|
|
|
1270
1355
|
*/
|
|
1271
1356
|
export declare const listTables: <ThrowOnError extends boolean = false>(options: Options<ListTablesData, ThrowOnError>) => import("./client").RequestResult<ListTablesResponses, ListTablesErrors, ThrowOnError, "fields">;
|
|
1272
1357
|
/**
|
|
1273
|
-
*
|
|
1274
|
-
*
|
|
1358
|
+
* Query Staging Tables with SQL
|
|
1359
|
+
* Execute SQL queries on DuckDB staging tables for data inspection and validation.
|
|
1275
1360
|
*
|
|
1276
|
-
*
|
|
1277
|
-
*
|
|
1278
|
-
* and validating data before ingestion.
|
|
1361
|
+
* Query raw staging data directly with SQL before ingestion into the graph database.
|
|
1362
|
+
* Useful for data quality checks, validation, and exploratory analysis.
|
|
1279
1363
|
*
|
|
1280
|
-
* **Use
|
|
1281
|
-
*
|
|
1282
|
-
* -
|
|
1283
|
-
* -
|
|
1284
|
-
* - Track storage usage per table
|
|
1285
|
-
* - Identify failed or incomplete uploads
|
|
1286
|
-
* - Pre-ingestion validation
|
|
1364
|
+
* **Security Best Practice - Use Parameterized Queries:**
|
|
1365
|
+
* ALWAYS use query parameters instead of string concatenation to prevent SQL injection:
|
|
1366
|
+
* - ✅ SAFE: `SELECT * FROM Entity WHERE type = ? LIMIT ?` with `parameters: ["Company", 100]`
|
|
1367
|
+
* - ❌ UNSAFE: `SELECT * FROM Entity WHERE type = 'Company' LIMIT 100` with user input concatenated into SQL string
|
|
1287
1368
|
*
|
|
1288
|
-
*
|
|
1289
|
-
* - File ID, name, and format (parquet, csv, json)
|
|
1290
|
-
* - Size in bytes and row count (if available)
|
|
1291
|
-
* - Upload status and method
|
|
1292
|
-
* - Creation and upload timestamps
|
|
1293
|
-
* - S3 key for reference
|
|
1369
|
+
* Query parameters provide automatic escaping and type safety. Use `?` placeholders with parameters array.
|
|
1294
1370
|
*
|
|
1295
|
-
* **
|
|
1296
|
-
* -
|
|
1297
|
-
* -
|
|
1298
|
-
* -
|
|
1299
|
-
* -
|
|
1300
|
-
* -
|
|
1371
|
+
* **Use Cases:**
|
|
1372
|
+
* - Validate data quality before graph ingestion
|
|
1373
|
+
* - Inspect row-level data for debugging
|
|
1374
|
+
* - Run analytics on staging tables
|
|
1375
|
+
* - Check for duplicates, nulls, or data issues
|
|
1376
|
+
* - Preview data transformations
|
|
1301
1377
|
*
|
|
1302
|
-
* **
|
|
1303
|
-
*
|
|
1304
|
-
*
|
|
1305
|
-
*
|
|
1306
|
-
*
|
|
1307
|
-
* - File listing is included - no credit consumption
|
|
1308
|
-
*/
|
|
1309
|
-
export declare const listTableFiles: <ThrowOnError extends boolean = false>(options: Options<ListTableFilesData, ThrowOnError>) => import("./client").RequestResult<ListTableFilesResponses, ListTableFilesErrors, ThrowOnError, "fields">;
|
|
1310
|
-
/**
|
|
1311
|
-
* Get File Upload URL
|
|
1312
|
-
* Generate a presigned S3 URL for secure file upload.
|
|
1378
|
+
* **Workflow:**
|
|
1379
|
+
* 1. Upload data files via `POST /tables/{table_name}/files`
|
|
1380
|
+
* 2. Query staging tables to validate: `POST /tables/query`
|
|
1381
|
+
* 3. Fix any data issues by re-uploading
|
|
1382
|
+
* 4. Ingest validated data: `POST /tables/ingest`
|
|
1313
1383
|
*
|
|
1314
|
-
*
|
|
1315
|
-
*
|
|
1316
|
-
*
|
|
1384
|
+
* **Supported SQL:**
|
|
1385
|
+
* - Full DuckDB SQL syntax
|
|
1386
|
+
* - SELECT, JOIN, WHERE, GROUP BY, ORDER BY
|
|
1387
|
+
* - Aggregations, window functions, CTEs
|
|
1388
|
+
* - Multiple table joins across staging area
|
|
1317
1389
|
*
|
|
1318
|
-
* **
|
|
1319
|
-
*
|
|
1320
|
-
*
|
|
1321
|
-
*
|
|
1322
|
-
*
|
|
1323
|
-
*
|
|
1390
|
+
* **Common Operations:**
|
|
1391
|
+
* - Count rows: `SELECT COUNT(*) FROM Entity`
|
|
1392
|
+
* - Filter by type: `SELECT * FROM Entity WHERE entity_type = ? LIMIT ?` with `parameters: ["Company", 100]`
|
|
1393
|
+
* - Check for nulls: `SELECT * FROM Entity WHERE name IS NULL LIMIT 10`
|
|
1394
|
+
* - Find duplicates: `SELECT identifier, COUNT(*) as cnt FROM Entity GROUP BY identifier HAVING COUNT(*) > 1`
|
|
1395
|
+
* - Filter amounts: `SELECT * FROM Transaction WHERE amount > ? AND date >= ?` with `parameters: [1000, "2024-01-01"]`
|
|
1324
1396
|
*
|
|
1325
|
-
* **
|
|
1326
|
-
* -
|
|
1327
|
-
* -
|
|
1328
|
-
* -
|
|
1397
|
+
* **Limits:**
|
|
1398
|
+
* - Query timeout: 30 seconds
|
|
1399
|
+
* - Result limit: 10,000 rows (use LIMIT clause)
|
|
1400
|
+
* - Read-only: No INSERT, UPDATE, DELETE
|
|
1401
|
+
* - User's tables only: Cannot query other users' data
|
|
1329
1402
|
*
|
|
1330
|
-
* **
|
|
1331
|
-
*
|
|
1332
|
-
* -
|
|
1333
|
-
* -
|
|
1334
|
-
*
|
|
1403
|
+
* **Subgraph Support:**
|
|
1404
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1405
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1406
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1407
|
+
* Each subgraph has its own independent staging tables.
|
|
1335
1408
|
*
|
|
1336
|
-
* **
|
|
1337
|
-
*
|
|
1338
|
-
*
|
|
1409
|
+
* **Shared Repositories:**
|
|
1410
|
+
* Shared repositories (SEC, etc.) do not allow direct SQL queries.
|
|
1411
|
+
* Use the graph query endpoint instead: `POST /v1/graphs/{graph_id}/query`
|
|
1339
1412
|
*
|
|
1340
|
-
* **
|
|
1341
|
-
*
|
|
1342
|
-
* - Use appropriate Content-Type header when uploading to S3
|
|
1343
|
-
* - File extension must match content type
|
|
1344
|
-
* - Upload URL generation is included - no credit consumption
|
|
1413
|
+
* **Note:**
|
|
1414
|
+
* Staging table queries are included - no credit consumption
|
|
1345
1415
|
*/
|
|
1346
|
-
export declare const
|
|
1416
|
+
export declare const queryTables: <ThrowOnError extends boolean = false>(options: Options<QueryTablesData, ThrowOnError>) => import("./client").RequestResult<QueryTablesResponses, QueryTablesErrors, ThrowOnError, "fields">;
|
|
1347
1417
|
/**
|
|
1348
|
-
*
|
|
1349
|
-
*
|
|
1350
|
-
*
|
|
1351
|
-
* Remove unwanted, duplicate, or incorrect files from staging tables before ingestion.
|
|
1352
|
-
* The file is deleted from both S3 and database tracking, and table statistics
|
|
1353
|
-
* are automatically recalculated.
|
|
1418
|
+
* Create View
|
|
1419
|
+
* Generate financial report view from data source (dual-mode support).
|
|
1354
1420
|
*
|
|
1355
|
-
* **
|
|
1356
|
-
* -
|
|
1357
|
-
* -
|
|
1358
|
-
* -
|
|
1359
|
-
* - Fix data quality issues before ingestion
|
|
1360
|
-
* - Manage storage usage
|
|
1421
|
+
* **Mode 1: Transaction Aggregation (generate_from_transactions)**
|
|
1422
|
+
* - Aggregates raw transaction data to trial balance
|
|
1423
|
+
* - Creates facts on-demand
|
|
1424
|
+
* - Shows real-time reporting from source of truth
|
|
1361
1425
|
*
|
|
1362
|
-
* **
|
|
1363
|
-
*
|
|
1364
|
-
*
|
|
1365
|
-
*
|
|
1366
|
-
* 4. DuckDB automatically excludes file from future queries
|
|
1367
|
-
*
|
|
1368
|
-
* **Security:**
|
|
1369
|
-
* - Write access required (verified via auth)
|
|
1370
|
-
* - Shared repositories block file deletions
|
|
1371
|
-
* - Full audit trail of deletion operations
|
|
1372
|
-
* - Cannot delete after ingestion to graph
|
|
1426
|
+
* **Mode 2: Existing Facts (pivot_existing_facts)**
|
|
1427
|
+
* - Queries existing Fact nodes
|
|
1428
|
+
* - Supports multi-dimensional analysis
|
|
1429
|
+
* - Works with SEC filings and pre-computed facts
|
|
1373
1430
|
*
|
|
1374
|
-
*
|
|
1375
|
-
* -
|
|
1376
|
-
* -
|
|
1377
|
-
* -
|
|
1378
|
-
* - Consider re-uploading corrected version after deletion
|
|
1379
|
-
* - File deletion is included - no credit consumption
|
|
1431
|
+
* Both modes:
|
|
1432
|
+
* - Build FactGrid from data
|
|
1433
|
+
* - Generate pivot table presentation
|
|
1434
|
+
* - Return consistent response format
|
|
1380
1435
|
*/
|
|
1381
|
-
export declare const
|
|
1436
|
+
export declare const createView: <ThrowOnError extends boolean = false>(options: Options<CreateViewData, ThrowOnError>) => import("./client").RequestResult<CreateViewResponses, CreateViewErrors, ThrowOnError, "fields">;
|
|
1382
1437
|
/**
|
|
1383
|
-
*
|
|
1384
|
-
*
|
|
1438
|
+
* Save View
|
|
1439
|
+
* Save or update view as materialized report in the graph.
|
|
1385
1440
|
*
|
|
1386
|
-
*
|
|
1387
|
-
*
|
|
1388
|
-
*
|
|
1441
|
+
* Converts computed view results into persistent Report, Fact, and Structure nodes.
|
|
1442
|
+
* This establishes what data exists in the subgraph, which then defines what
|
|
1443
|
+
* needs to be exported for publishing to the parent graph.
|
|
1389
1444
|
*
|
|
1390
|
-
* **
|
|
1391
|
-
* -
|
|
1392
|
-
* -
|
|
1393
|
-
* - Debug upload issues
|
|
1394
|
-
* - Verify file format and size
|
|
1395
|
-
* - Track file lifecycle
|
|
1445
|
+
* **Create Mode** (no report_id provided):
|
|
1446
|
+
* - Generates new report_id from entity + period + report type
|
|
1447
|
+
* - Creates new Report, Facts, and Structures
|
|
1396
1448
|
*
|
|
1397
|
-
* **
|
|
1398
|
-
*
|
|
1449
|
+
* **Update Mode** (report_id provided):
|
|
1450
|
+
* - Deletes all existing Facts and Structures for the report
|
|
1451
|
+
* - Updates Report metadata
|
|
1452
|
+
* - Creates fresh Facts and Structures from current view
|
|
1453
|
+
* - Useful for refreshing reports with updated data or view configurations
|
|
1454
|
+
*
|
|
1455
|
+
* **This is NOT publishing** - it only creates nodes in the subgraph workspace.
|
|
1456
|
+
* Publishing (export → parquet → parent ingest) happens separately.
|
|
1457
|
+
*
|
|
1458
|
+
* Creates/Updates:
|
|
1459
|
+
* - Report node with metadata
|
|
1460
|
+
* - Fact nodes with all aspects (period, entity, element, unit)
|
|
1461
|
+
* - PresentationStructure nodes (how facts are displayed)
|
|
1462
|
+
* - CalculationStructure nodes (how facts roll up)
|
|
1463
|
+
*
|
|
1464
|
+
* Returns:
|
|
1465
|
+
* - report_id: Unique identifier used as parquet export prefix
|
|
1466
|
+
* - parquet_export_prefix: Filename prefix for future exports
|
|
1467
|
+
* - All created facts and structures
|
|
1399
1468
|
*/
|
|
1400
|
-
export declare const
|
|
1469
|
+
export declare const saveView: <ThrowOnError extends boolean = false>(options: Options<SaveViewData, ThrowOnError>) => import("./client").RequestResult<SaveViewResponses, SaveViewErrors, ThrowOnError, "fields">;
|
|
1401
1470
|
/**
|
|
1402
|
-
*
|
|
1403
|
-
*
|
|
1471
|
+
* Get Materialization Status
|
|
1472
|
+
* Get current materialization status for the graph.
|
|
1404
1473
|
*
|
|
1405
|
-
*
|
|
1406
|
-
*
|
|
1407
|
-
* registers the DuckDB table for queries.
|
|
1474
|
+
* Shows whether the graph is stale (DuckDB has changes not yet in graph database),
|
|
1475
|
+
* when it was last materialized, and how long since last materialization.
|
|
1408
1476
|
*
|
|
1409
|
-
* **Status
|
|
1410
|
-
* -
|
|
1411
|
-
* -
|
|
1412
|
-
* -
|
|
1413
|
-
*
|
|
1414
|
-
*
|
|
1415
|
-
*
|
|
1416
|
-
*
|
|
1417
|
-
*
|
|
1418
|
-
*
|
|
1419
|
-
*
|
|
1420
|
-
*
|
|
1421
|
-
*
|
|
1422
|
-
*
|
|
1423
|
-
* **Row Count Calculation:**
|
|
1424
|
-
* - **Parquet**: Exact count from file metadata
|
|
1425
|
-
* - **CSV**: Count rows (minus header)
|
|
1426
|
-
* - **JSON**: Count array elements
|
|
1427
|
-
* - **Fallback**: Estimate from file size if reading fails
|
|
1428
|
-
*
|
|
1429
|
-
* **Storage Limits:**
|
|
1430
|
-
* Enforced per subscription tier. Returns HTTP 413 if limit exceeded.
|
|
1431
|
-
* Check current usage before large uploads.
|
|
1477
|
+
* **Status Information:**
|
|
1478
|
+
* - Whether graph is currently stale
|
|
1479
|
+
* - Reason for staleness if applicable
|
|
1480
|
+
* - When graph became stale
|
|
1481
|
+
* - When graph was last materialized
|
|
1482
|
+
* - Total materialization count
|
|
1483
|
+
* - Hours since last materialization
|
|
1484
|
+
*
|
|
1485
|
+
* **Use Cases:**
|
|
1486
|
+
* - Decide if materialization is needed
|
|
1487
|
+
* - Monitor graph freshness
|
|
1488
|
+
* - Track materialization history
|
|
1489
|
+
* - Understand data pipeline state
|
|
1432
1490
|
*
|
|
1433
1491
|
* **Important Notes:**
|
|
1434
|
-
* -
|
|
1435
|
-
* -
|
|
1436
|
-
* -
|
|
1437
|
-
* -
|
|
1438
|
-
* - Status updates are included - no credit consumption
|
|
1492
|
+
* - Stale graph means DuckDB has changes not in graph
|
|
1493
|
+
* - Graph becomes stale after file deletions
|
|
1494
|
+
* - Materialization clears staleness
|
|
1495
|
+
* - Status retrieval is included - no credit consumption
|
|
1439
1496
|
*/
|
|
1440
|
-
export declare const
|
|
1497
|
+
export declare const getMaterializationStatus: <ThrowOnError extends boolean = false>(options: Options<GetMaterializationStatusData, ThrowOnError>) => import("./client").RequestResult<GetMaterializationStatusResponses, GetMaterializationStatusErrors, ThrowOnError, "fields">;
|
|
1441
1498
|
/**
|
|
1442
|
-
*
|
|
1443
|
-
*
|
|
1499
|
+
* Materialize Graph from DuckDB
|
|
1500
|
+
* Rebuild entire graph from DuckDB staging tables (materialized view pattern).
|
|
1444
1501
|
*
|
|
1445
|
-
*
|
|
1446
|
-
*
|
|
1502
|
+
* This endpoint rebuilds the complete graph database from the current state of DuckDB
|
|
1503
|
+
* staging tables. It automatically discovers all tables, ingests them in the correct
|
|
1504
|
+
* order (nodes before relationships), and clears the staleness flag.
|
|
1447
1505
|
*
|
|
1448
|
-
* **Use
|
|
1449
|
-
* -
|
|
1450
|
-
* -
|
|
1451
|
-
* -
|
|
1452
|
-
* -
|
|
1506
|
+
* **When to Use:**
|
|
1507
|
+
* - After batch uploads (files uploaded with ingest_to_graph=false)
|
|
1508
|
+
* - After cascade file deletions (graph marked stale)
|
|
1509
|
+
* - To ensure graph consistency with DuckDB state
|
|
1510
|
+
* - Periodic full refresh
|
|
1453
1511
|
*
|
|
1454
|
-
* **
|
|
1455
|
-
* 1.
|
|
1456
|
-
* 2.
|
|
1457
|
-
* 3.
|
|
1458
|
-
* 4.
|
|
1459
|
-
* 5.
|
|
1460
|
-
*
|
|
1512
|
+
* **What Happens:**
|
|
1513
|
+
* 1. Discovers all tables for the graph from PostgreSQL registry
|
|
1514
|
+
* 2. Sorts tables (nodes before relationships)
|
|
1515
|
+
* 3. Ingests all tables from DuckDB to graph in order
|
|
1516
|
+
* 4. Clears staleness flag on success
|
|
1517
|
+
* 5. Returns detailed materialization report
|
|
1518
|
+
*
|
|
1519
|
+
* **Staleness Check:**
|
|
1520
|
+
* By default, only materializes if graph is stale (after deletions or missed ingestions).
|
|
1521
|
+
* Use `force=true` to rebuild regardless of staleness.
|
|
1461
1522
|
*
|
|
1462
1523
|
* **Rebuild Feature:**
|
|
1463
1524
|
* Setting `rebuild=true` regenerates the entire graph database from scratch:
|
|
1464
|
-
* - Deletes existing
|
|
1525
|
+
* - Deletes existing graph database
|
|
1465
1526
|
* - Recreates with fresh schema from active GraphSchema
|
|
1466
1527
|
* - Ingests all data files
|
|
1467
|
-
* - Safe operation -
|
|
1528
|
+
* - Safe operation - DuckDB is source of truth
|
|
1468
1529
|
* - Useful for schema changes or data corrections
|
|
1469
1530
|
* - Graph marked as 'rebuilding' during process
|
|
1470
1531
|
*
|
|
1471
|
-
* **
|
|
1472
|
-
*
|
|
1473
|
-
*
|
|
1474
|
-
* - Detailed error reporting per table
|
|
1475
|
-
* - Graph status tracking throughout process
|
|
1476
|
-
* - Automatic failure recovery and cleanup
|
|
1532
|
+
* **Table Ordering:**
|
|
1533
|
+
* Node tables (PascalCase) are ingested before relationship tables (UPPERCASE) to
|
|
1534
|
+
* ensure referential integrity.
|
|
1477
1535
|
*
|
|
1478
|
-
* **
|
|
1479
|
-
*
|
|
1480
|
-
*
|
|
1481
|
-
* - Total execution metrics provided
|
|
1482
|
-
* - Scales to thousands of files
|
|
1483
|
-
* - Optimized for large datasets
|
|
1536
|
+
* **Error Handling:**
|
|
1537
|
+
* With `ignore_errors=true` (default), continues materializing even if individual
|
|
1538
|
+
* rows fail. Failed rows are logged but don't stop the process.
|
|
1484
1539
|
*
|
|
1485
1540
|
* **Concurrency Control:**
|
|
1486
|
-
* Only one
|
|
1541
|
+
* Only one materialization can run per graph at a time. If another materialization is in progress,
|
|
1487
1542
|
* you'll receive a 409 Conflict error. The distributed lock automatically expires after
|
|
1488
|
-
* the configured TTL (default: 1 hour) to prevent deadlocks from failed
|
|
1543
|
+
* the configured TTL (default: 1 hour) to prevent deadlocks from failed materializations.
|
|
1544
|
+
*
|
|
1545
|
+
* **Performance:**
|
|
1546
|
+
* Full graph materialization can take minutes for large datasets. Consider running
|
|
1547
|
+
* during off-peak hours for production systems.
|
|
1548
|
+
*
|
|
1549
|
+
* **Credits:**
|
|
1550
|
+
* Materialization is included - no credit consumption
|
|
1551
|
+
*/
|
|
1552
|
+
export declare const materializeGraph: <ThrowOnError extends boolean = false>(options: Options<MaterializeGraphData, ThrowOnError>) => import("./client").RequestResult<MaterializeGraphResponses, MaterializeGraphErrors, ThrowOnError, "fields">;
|
|
1553
|
+
/**
|
|
1554
|
+
* List Files in Graph
|
|
1555
|
+
* List all files in the graph with optional filtering.
|
|
1556
|
+
*
|
|
1557
|
+
* Get a complete inventory of files across all tables or filtered by table name,
|
|
1558
|
+
* status, or other criteria. Files are first-class resources with independent lifecycle.
|
|
1559
|
+
*
|
|
1560
|
+
* **Query Parameters:**
|
|
1561
|
+
* - `table_name` (optional): Filter by table name
|
|
1562
|
+
* - `status` (optional): Filter by upload status (uploaded, pending, failed, etc.)
|
|
1563
|
+
*
|
|
1564
|
+
* **Use Cases:**
|
|
1565
|
+
* - Monitor file upload progress across all tables
|
|
1566
|
+
* - Verify files are ready for ingestion
|
|
1567
|
+
* - Check file metadata and sizes
|
|
1568
|
+
* - Track storage usage per graph
|
|
1569
|
+
* - Identify failed or incomplete uploads
|
|
1570
|
+
* - Audit file provenance
|
|
1571
|
+
*
|
|
1572
|
+
* **Returned Metadata:**
|
|
1573
|
+
* - File ID, name, and format (parquet, csv, json)
|
|
1574
|
+
* - Size in bytes and row count (if available)
|
|
1575
|
+
* - Upload status and timestamps
|
|
1576
|
+
* - DuckDB and graph ingestion status
|
|
1577
|
+
* - Table association
|
|
1578
|
+
*
|
|
1579
|
+
* **File Lifecycle Tracking:**
|
|
1580
|
+
* Multi-layer status across S3 → DuckDB → Graph pipeline
|
|
1489
1581
|
*
|
|
1490
1582
|
* **Important Notes:**
|
|
1491
|
-
* -
|
|
1492
|
-
* -
|
|
1493
|
-
* -
|
|
1494
|
-
* - Monitor progress via per-table results
|
|
1495
|
-
* - Check graph metadata for rebuild status
|
|
1496
|
-
* - Wait for current ingestion to complete before starting another
|
|
1497
|
-
* - Table ingestion is included - no credit consumption
|
|
1583
|
+
* - Files are graph-scoped, not table-scoped
|
|
1584
|
+
* - Use table_name parameter to filter by table
|
|
1585
|
+
* - File listing is included - no credit consumption
|
|
1498
1586
|
*/
|
|
1499
|
-
export declare const
|
|
1587
|
+
export declare const listFiles: <ThrowOnError extends boolean = false>(options: Options<ListFilesData, ThrowOnError>) => import("./client").RequestResult<ListFilesResponses, ListFilesErrors, ThrowOnError, "fields">;
|
|
1500
1588
|
/**
|
|
1501
|
-
*
|
|
1502
|
-
*
|
|
1589
|
+
* Create File Upload
|
|
1590
|
+
* Generate presigned S3 URL for file upload.
|
|
1503
1591
|
*
|
|
1504
|
-
*
|
|
1505
|
-
*
|
|
1592
|
+
* Initiate file upload by generating a secure, time-limited presigned S3 URL.
|
|
1593
|
+
* Files are first-class resources uploaded directly to S3.
|
|
1506
1594
|
*
|
|
1507
|
-
* **
|
|
1508
|
-
*
|
|
1509
|
-
* -
|
|
1510
|
-
* -
|
|
1595
|
+
* **Request Body:**
|
|
1596
|
+
* - `file_name`: Name of the file (1-255 characters)
|
|
1597
|
+
* - `file_format`: Format (parquet, csv, json)
|
|
1598
|
+
* - `table_name`: Table to associate file with
|
|
1511
1599
|
*
|
|
1512
|
-
*
|
|
1600
|
+
* **Upload Workflow:**
|
|
1601
|
+
* 1. Call this endpoint to get presigned URL
|
|
1602
|
+
* 2. PUT file directly to S3 URL
|
|
1603
|
+
* 3. Call PATCH /files/{file_id} with status='uploaded'
|
|
1604
|
+
* 4. Backend validates and stages in DuckDB immediately
|
|
1605
|
+
* 5. Background task ingests to graph
|
|
1606
|
+
*
|
|
1607
|
+
* **Supported Formats:**
|
|
1608
|
+
* - Parquet, CSV, JSON
|
|
1609
|
+
*
|
|
1610
|
+
* **Auto-Table Creation:**
|
|
1611
|
+
* Tables are automatically created if they don't exist.
|
|
1612
|
+
*
|
|
1613
|
+
* **Important Notes:**
|
|
1614
|
+
* - Presigned URLs expire (default: 1 hour)
|
|
1615
|
+
* - Files are graph-scoped, independent resources
|
|
1616
|
+
* - Upload URL generation is included - no credit consumption
|
|
1617
|
+
*/
|
|
1618
|
+
export declare const createFileUpload: <ThrowOnError extends boolean = false>(options: Options<CreateFileUploadData, ThrowOnError>) => import("./client").RequestResult<CreateFileUploadResponses, CreateFileUploadErrors, ThrowOnError, "fields">;
|
|
1619
|
+
/**
|
|
1620
|
+
* Delete File
|
|
1621
|
+
* Delete file from all layers.
|
|
1622
|
+
*
|
|
1623
|
+
* Remove file from S3, database tracking, and optionally from DuckDB and graph.
|
|
1624
|
+
* Files are deleted by file_id, independent of table context.
|
|
1625
|
+
*
|
|
1626
|
+
* **Query Parameters:**
|
|
1627
|
+
* - `cascade` (optional, default=false): Delete from all layers including DuckDB
|
|
1628
|
+
*
|
|
1629
|
+
* **What Happens (cascade=false):**
|
|
1630
|
+
* 1. File deleted from S3
|
|
1631
|
+
* 2. Database record removed
|
|
1632
|
+
* 3. Table statistics updated
|
|
1633
|
+
*
|
|
1634
|
+
* **What Happens (cascade=true):**
|
|
1635
|
+
* 1. File data deleted from all DuckDB tables (by file_id)
|
|
1636
|
+
* 2. Graph marked as stale
|
|
1637
|
+
* 3. File deleted from S3
|
|
1638
|
+
* 4. Database record removed
|
|
1639
|
+
* 5. Table statistics updated
|
|
1513
1640
|
*
|
|
1514
1641
|
* **Use Cases:**
|
|
1515
|
-
* -
|
|
1516
|
-
* -
|
|
1517
|
-
* -
|
|
1518
|
-
* -
|
|
1519
|
-
* - Preview data transformations
|
|
1642
|
+
* - Remove incorrect or duplicate files
|
|
1643
|
+
* - Clean up failed uploads
|
|
1644
|
+
* - Delete files before graph ingestion
|
|
1645
|
+
* - Surgical data removal with cascade
|
|
1520
1646
|
*
|
|
1521
|
-
* **
|
|
1522
|
-
*
|
|
1523
|
-
*
|
|
1524
|
-
*
|
|
1525
|
-
* 4. Ingest validated data: `POST /tables/ingest`
|
|
1647
|
+
* **Security:**
|
|
1648
|
+
* - Write access required
|
|
1649
|
+
* - Shared repositories block deletions
|
|
1650
|
+
* - Full audit trail
|
|
1526
1651
|
*
|
|
1527
|
-
* **
|
|
1528
|
-
* -
|
|
1529
|
-
* -
|
|
1530
|
-
* -
|
|
1531
|
-
|
|
1652
|
+
* **Important:**
|
|
1653
|
+
* - Use cascade=true for immediate DuckDB cleanup
|
|
1654
|
+
* - Graph rebuild recommended after cascade deletion
|
|
1655
|
+
* - File deletion is included - no credit consumption
|
|
1656
|
+
*/
|
|
1657
|
+
export declare const deleteFile: <ThrowOnError extends boolean = false>(options: Options<DeleteFileData, ThrowOnError>) => import("./client").RequestResult<DeleteFileResponses, DeleteFileErrors, ThrowOnError, "fields">;
|
|
1658
|
+
/**
|
|
1659
|
+
* Get File Information
|
|
1660
|
+
* Get detailed information about a specific file.
|
|
1532
1661
|
*
|
|
1533
|
-
*
|
|
1534
|
-
* -
|
|
1535
|
-
* - Filter by type: `SELECT * FROM Entity WHERE entity_type = ? LIMIT ?` with `parameters: ["Company", 100]`
|
|
1536
|
-
* - Check for nulls: `SELECT * FROM Entity WHERE name IS NULL LIMIT 10`
|
|
1537
|
-
* - Find duplicates: `SELECT identifier, COUNT(*) as cnt FROM Entity GROUP BY identifier HAVING COUNT(*) > 1`
|
|
1538
|
-
* - Filter amounts: `SELECT * FROM Transaction WHERE amount > ? AND date >= ?` with `parameters: [1000, "2024-01-01"]`
|
|
1662
|
+
* Retrieve comprehensive metadata for a single file by file_id, independent of
|
|
1663
|
+
* table context. Files are first-class resources with complete lifecycle tracking.
|
|
1539
1664
|
*
|
|
1540
|
-
* **
|
|
1541
|
-
* -
|
|
1542
|
-
* -
|
|
1543
|
-
* -
|
|
1544
|
-
* -
|
|
1665
|
+
* **Returned Information:**
|
|
1666
|
+
* - File ID, name, format, size
|
|
1667
|
+
* - Upload status and timestamps
|
|
1668
|
+
* - **Enhanced Multi-Layer Status** (new in this version):
|
|
1669
|
+
* - S3 layer: upload_status, uploaded_at, size_bytes, row_count
|
|
1670
|
+
* - DuckDB layer: duckdb_status, duckdb_staged_at, duckdb_row_count
|
|
1671
|
+
* - Graph layer: graph_status, graph_ingested_at
|
|
1672
|
+
* - Table association
|
|
1673
|
+
* - S3 location
|
|
1674
|
+
*
|
|
1675
|
+
* **Multi-Layer Pipeline Visibility:**
|
|
1676
|
+
* The `layers` object provides independent status tracking across the three-tier
|
|
1677
|
+
* data pipeline:
|
|
1678
|
+
* - **S3 (Immutable Source)**: File upload and validation
|
|
1679
|
+
* - **DuckDB (Mutable Staging)**: Immediate queryability with file provenance
|
|
1680
|
+
* - **Graph (Immutable View)**: Optional graph database materialization
|
|
1681
|
+
*
|
|
1682
|
+
* Each layer shows its own status, timestamp, and row count (where applicable),
|
|
1683
|
+
* enabling precise debugging and monitoring of the data ingestion flow.
|
|
1545
1684
|
*
|
|
1546
|
-
* **
|
|
1547
|
-
*
|
|
1548
|
-
*
|
|
1685
|
+
* **Use Cases:**
|
|
1686
|
+
* - Validate file upload completion
|
|
1687
|
+
* - Monitor multi-layer ingestion progress in real-time
|
|
1688
|
+
* - Debug upload or staging issues at specific layers
|
|
1689
|
+
* - Verify file metadata and row counts
|
|
1690
|
+
* - Track file provenance through the pipeline
|
|
1691
|
+
* - Identify bottlenecks in the ingestion process
|
|
1549
1692
|
*
|
|
1550
1693
|
* **Note:**
|
|
1551
|
-
*
|
|
1694
|
+
* File info retrieval is included - no credit consumption
|
|
1552
1695
|
*/
|
|
1553
|
-
export declare const
|
|
1696
|
+
export declare const getFile: <ThrowOnError extends boolean = false>(options: Options<GetFileData, ThrowOnError>) => import("./client").RequestResult<GetFileResponses, GetFileErrors, ThrowOnError, "fields">;
|
|
1697
|
+
/**
|
|
1698
|
+
* Update File Status
|
|
1699
|
+
* Update file status and trigger processing.
|
|
1700
|
+
*
|
|
1701
|
+
* Update file status after upload completion. Setting status='uploaded' triggers
|
|
1702
|
+
* immediate DuckDB staging and optional graph ingestion.
|
|
1703
|
+
*
|
|
1704
|
+
* **Request Body:**
|
|
1705
|
+
* - `status`: New status (uploaded, disabled, failed)
|
|
1706
|
+
* - `ingest_to_graph` (optional): If true, auto-ingest to graph after DuckDB staging
|
|
1707
|
+
*
|
|
1708
|
+
* **What Happens (status='uploaded'):**
|
|
1709
|
+
* 1. File validated in S3
|
|
1710
|
+
* 2. Row count calculated
|
|
1711
|
+
* 3. DuckDB staging triggered immediately (Celery task)
|
|
1712
|
+
* 4. If ingest_to_graph=true, graph ingestion queued
|
|
1713
|
+
* 5. File queryable in DuckDB within seconds
|
|
1714
|
+
*
|
|
1715
|
+
* **Use Cases:**
|
|
1716
|
+
* - Signal upload completion
|
|
1717
|
+
* - Trigger immediate DuckDB staging
|
|
1718
|
+
* - Enable/disable files
|
|
1719
|
+
* - Mark failed uploads
|
|
1720
|
+
*
|
|
1721
|
+
* **Important:**
|
|
1722
|
+
* - Files must exist in S3 before marking uploaded
|
|
1723
|
+
* - DuckDB staging happens asynchronously
|
|
1724
|
+
* - Graph ingestion is optional (ingest_to_graph flag)
|
|
1725
|
+
*/
|
|
1726
|
+
export declare const updateFile: <ThrowOnError extends boolean = false>(options: Options<UpdateFileData, ThrowOnError>) => import("./client").RequestResult<UpdateFileResponses, UpdateFileErrors, ThrowOnError, "fields">;
|
|
1554
1727
|
/**
|
|
1555
1728
|
* Get User Graphs and Repositories
|
|
1556
1729
|
* List all graph databases and shared repositories accessible to the current user.
|