|
1 | | -# delve_client_sdk |
| 1 | +# relationalai-sdk |
2 | 2 |
|
3 | | -DelveClientSdk - JavaScript client for delve_client_sdk |
4 | | -This is a Client SDK for Delve API |
5 | | -This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: |
6 | | - |
7 | | -- API version: 1.1.3 |
8 | | -- Package version: 1.1.3 |
9 | | -- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen |
10 | | -For more information, please visit [https://www.relational.ai/support](https://www.relational.ai/support) |
| 3 | +RelationalAI SDK for JavaScript |
11 | 4 |
|
12 | 5 | ## Installation |
13 | 6 |
|
14 | | -### For [Node.js](https://nodejs.org/) |
15 | | - |
16 | | -#### npm |
17 | | - |
18 | | -To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). |
19 | | - |
20 | | -Then install it via: |
21 | | - |
22 | | -```shell |
23 | | -npm install delve_client_sdk --save |
24 | | -``` |
25 | | - |
26 | | -Finally, you need to build the module: |
27 | | - |
28 | | -```shell |
29 | | -npm run build |
30 | | -``` |
31 | | - |
32 | | -##### Local development |
33 | | - |
34 | | -To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run: |
35 | | - |
36 | | -```shell |
37 | | -npm install |
38 | | -``` |
39 | | - |
40 | | -Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`: |
41 | | - |
42 | | -```shell |
43 | | -npm link |
44 | | -``` |
45 | | - |
46 | | -To use the link you just defined in your project, switch to the directory you want to use your delve_client_sdk from, and run: |
47 | | - |
48 | | -```shell |
49 | | -npm link /path/to/<JAVASCRIPT_CLIENT_DIR> |
50 | | -``` |
51 | | - |
52 | | -Finally, you need to build the module: |
53 | | - |
54 | | -```shell |
55 | | -npm run build |
56 | | -``` |
57 | | - |
58 | | -#### git |
59 | | - |
60 | | -You can install the library via `git`: |
61 | | - |
62 | | -```shell |
63 | | - npm install RelationalAI-oss/DelveJavaScriptClientSDK --save |
64 | 7 | ``` |
65 | | - |
66 | | -### For browser |
67 | | - |
68 | | -The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following |
69 | | -the above steps with Node.js and installing browserify with `npm install -g browserify`, |
70 | | -perform the following (assuming *main.js* is your entry file): |
71 | | - |
72 | | -```shell |
73 | | -browserify main.js > bundle.js |
| 8 | +npm install relationalai-sdk |
74 | 9 | ``` |
75 | 10 |
|
76 | | -Then include *bundle.js* in the HTML pages. |
| 11 | +## Usage |
77 | 12 |
|
78 | | -### Webpack Configuration |
79 | | - |
80 | | -Using Webpack you may encounter the following error: "Module not found: Error: |
81 | | -Cannot resolve module", most certainly you should disable AMD loader. Add/merge |
82 | | -the following section to your webpack config: |
83 | | - |
84 | | -```javascript |
85 | | -module: { |
86 | | - rules: [ |
87 | | - { |
88 | | - parser: { |
89 | | - amd: false |
90 | | - } |
91 | | - } |
92 | | - ] |
93 | | -} |
94 | 13 | ``` |
| 14 | +import { LocalConnection } from 'relationalai-sdk'; |
95 | 15 |
|
96 | | -## Getting Started |
97 | | - |
98 | | -Please follow the [installation](#installation) instruction and execute the following JS code: |
99 | | - |
100 | | -```javascript |
101 | | -var DelveClientSdk = require('delve_client_sdk'); |
102 | | - |
103 | | - |
104 | | -var api = new DelveClientSdk.DefaultApi() |
105 | | -var transaction = new DelveClientSdk.Transaction(); // {Transaction} Optional description in *Markdown* |
106 | | -var callback = function(error, data, response) { |
107 | | - if (error) { |
108 | | - console.error(error); |
109 | | - } else { |
110 | | - console.log('API called successfully. Returned data: ' + data); |
111 | | - } |
112 | | -}; |
113 | | -api.transactionPost(transaction, callback); |
114 | | - |
| 16 | +const localConnection = new LocalConnection(); |
| 17 | +let res = await localConnection.connectToDatabase('dbname'); |
115 | 18 | ``` |
116 | | - |
117 | | -## Documentation for API Endpoints |
118 | | - |
119 | | -All URIs are relative to *http://127.0.0.1:8010* |
120 | | - |
121 | | -Class | Method | HTTP request | Description |
122 | | ------------- | ------------- | ------------- | ------------- |
123 | | -*DelveClientSdk.DefaultApi* | [**transactionPost**](docs/DefaultApi.md#transactionPost) | **POST** /transaction | Issues a transaction to be executed |
124 | | - |
125 | | - |
126 | | -## Documentation for Models |
127 | | - |
128 | | - - [DelveClientSdk.AbstractProblem](docs/AbstractProblem.md) |
129 | | - - [DelveClientSdk.Action](docs/Action.md) |
130 | | - - [DelveClientSdk.ActionResult](docs/ActionResult.md) |
131 | | - - [DelveClientSdk.Appl](docs/Appl.md) |
132 | | - - [DelveClientSdk.Area](docs/Area.md) |
133 | | - - [DelveClientSdk.ArityMismatchError](docs/ArityMismatchError.md) |
134 | | - - [DelveClientSdk.CSVFileSchema](docs/CSVFileSchema.md) |
135 | | - - [DelveClientSdk.CSVFileSyntax](docs/CSVFileSyntax.md) |
136 | | - - [DelveClientSdk.CardinalityAction](docs/CardinalityAction.md) |
137 | | - - [DelveClientSdk.CardinalityActionResult](docs/CardinalityActionResult.md) |
138 | | - - [DelveClientSdk.ClientProblem](docs/ClientProblem.md) |
139 | | - - [DelveClientSdk.CollectProblemsAction](docs/CollectProblemsAction.md) |
140 | | - - [DelveClientSdk.CollectProblemsActionResult](docs/CollectProblemsActionResult.md) |
141 | | - - [DelveClientSdk.ComparisonChainError](docs/ComparisonChainError.md) |
142 | | - - [DelveClientSdk.Cons](docs/Cons.md) |
143 | | - - [DelveClientSdk.ExceptionProblem](docs/ExceptionProblem.md) |
144 | | - - [DelveClientSdk.FileSchema](docs/FileSchema.md) |
145 | | - - [DelveClientSdk.FileSyntax](docs/FileSyntax.md) |
146 | | - - [DelveClientSdk.FrontProblem](docs/FrontProblem.md) |
147 | | - - [DelveClientSdk.ICViolation](docs/ICViolation.md) |
148 | | - - [DelveClientSdk.ImportAction](docs/ImportAction.md) |
149 | | - - [DelveClientSdk.ImportActionResult](docs/ImportActionResult.md) |
150 | | - - [DelveClientSdk.InfraError](docs/InfraError.md) |
151 | | - - [DelveClientSdk.InstallAction](docs/InstallAction.md) |
152 | | - - [DelveClientSdk.InstallActionResult](docs/InstallActionResult.md) |
153 | | - - [DelveClientSdk.IntegrityConstraintProblem](docs/IntegrityConstraintProblem.md) |
154 | | - - [DelveClientSdk.IntegrityConstraintViolation](docs/IntegrityConstraintViolation.md) |
155 | | - - [DelveClientSdk.JSONFileSchema](docs/JSONFileSchema.md) |
156 | | - - [DelveClientSdk.JSONFileSyntax](docs/JSONFileSyntax.md) |
157 | | - - [DelveClientSdk.LabeledAction](docs/LabeledAction.md) |
158 | | - - [DelveClientSdk.LabeledActionResult](docs/LabeledActionResult.md) |
159 | | - - [DelveClientSdk.LinkedList](docs/LinkedList.md) |
160 | | - - [DelveClientSdk.ListEdbAction](docs/ListEdbAction.md) |
161 | | - - [DelveClientSdk.ListEdbActionResult](docs/ListEdbActionResult.md) |
162 | | - - [DelveClientSdk.ListSourceAction](docs/ListSourceAction.md) |
163 | | - - [DelveClientSdk.ListSourceActionResult](docs/ListSourceActionResult.md) |
164 | | - - [DelveClientSdk.Literal](docs/Literal.md) |
165 | | - - [DelveClientSdk.LoadData](docs/LoadData.md) |
166 | | - - [DelveClientSdk.LoadDataAction](docs/LoadDataAction.md) |
167 | | - - [DelveClientSdk.LoadDataActionResult](docs/LoadDataActionResult.md) |
168 | | - - [DelveClientSdk.ModifyWorkspaceAction](docs/ModifyWorkspaceAction.md) |
169 | | - - [DelveClientSdk.ModifyWorkspaceActionResult](docs/ModifyWorkspaceActionResult.md) |
170 | | - - [DelveClientSdk.Nil](docs/Nil.md) |
171 | | - - [DelveClientSdk.OutputProblem](docs/OutputProblem.md) |
172 | | - - [DelveClientSdk.PairAnyValueAnyValue](docs/PairAnyValueAnyValue.md) |
173 | | - - [DelveClientSdk.ParseAction](docs/ParseAction.md) |
174 | | - - [DelveClientSdk.ParseActionResult](docs/ParseActionResult.md) |
175 | | - - [DelveClientSdk.PersistProblem](docs/PersistProblem.md) |
176 | | - - [DelveClientSdk.Point](docs/Point.md) |
177 | | - - [DelveClientSdk.QueryAction](docs/QueryAction.md) |
178 | | - - [DelveClientSdk.QueryActionResult](docs/QueryActionResult.md) |
179 | | - - [DelveClientSdk.Range](docs/Range.md) |
180 | | - - [DelveClientSdk.RelKey](docs/RelKey.md) |
181 | | - - [DelveClientSdk.Relation](docs/Relation.md) |
182 | | - - [DelveClientSdk.SetOptionsAction](docs/SetOptionsAction.md) |
183 | | - - [DelveClientSdk.SetOptionsActionResult](docs/SetOptionsActionResult.md) |
184 | | - - [DelveClientSdk.Source](docs/Source.md) |
185 | | - - [DelveClientSdk.SyntaxError](docs/SyntaxError.md) |
186 | | - - [DelveClientSdk.SyntaxNode](docs/SyntaxNode.md) |
187 | | - - [DelveClientSdk.Token](docs/Token.md) |
188 | | - - [DelveClientSdk.Transaction](docs/Transaction.md) |
189 | | - - [DelveClientSdk.TransactionResult](docs/TransactionResult.md) |
190 | | - - [DelveClientSdk.UndefinedError](docs/UndefinedError.md) |
191 | | - - [DelveClientSdk.UpdateAction](docs/UpdateAction.md) |
192 | | - - [DelveClientSdk.UpdateActionResult](docs/UpdateActionResult.md) |
193 | | - - [DelveClientSdk.WorkspaceLoadProblem](docs/WorkspaceLoadProblem.md) |
194 | | - |
195 | | - |
196 | | -## Documentation for Authorization |
197 | | - |
198 | | -All endpoints do not require authorization. |
0 commit comments