Get started
Get started using the Mind Lake SDK.
The TypeScript/Python SDK enables developers to execute SQL statements freely and perform encryption and decryption operations on specific data.
Installation
Install with package:
npm:
npm install mind-lake-sdkyarn:
yarn add mind-lake-sdk
Install from source:
Preparation
If you have TypeScript or Python environment configured in your local environment, you can jump to "Quick Start" (next section) directly.
Otherwise, you can follow a step-to-step tutorial to prepare the environment first.
Step-by-step tutorial: https://github.com/mind-network/mind-lake-sdk-typescript/blob/main/tutorial/README.md
SDK Quick Start
Checkout TypeScript Quick-start example
Checkout Python Quick-start example
More examples
The SDK developer has a few more examples to help understand.
More examples are welcome from the community. Please contact us.
Synopsis
The SDK offers a variety of APIs:
| API | Description |
|---|---|
MindLake <TypeScript | Python> | The general interfaces that apply to entire SDK, including the entry point `connect` method to connect to Mind Lake and managing user accounts as well as encryption keys. |
MindLake.DataLake <TypeScript | Python> | Managing the data tables and enabling execution of SQL queries. |
MindLake.Cryptor <TypeScript | Python> | Encrypting and decrypting data |
MindLake.Permission <TypeScript | Python> | Granting permission of decryption to other users for sharing |
Last updated