alekshs-test2 v0.0.2
tiledb-cloud
TiledbCloud - JavaScript client for tiledb-cloud TileDB Storage Platform REST API This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.4.0
- Package version: 1.4.0
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install tiledb-cloud --save
Finally, you need to build the module:
npm run build
Local development
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:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
To use the link you just defined in your project, switch to the directory you want to use your tiledb-cloud from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
git
If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var TiledbCloud = require('tiledb-cloud');
var defaultClient = TiledbCloud.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-TILEDB-REST-API-KEY'] = "Token"
// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'
// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN"
var api = new TiledbCloud.ArrayApi()
var namespace = "namespace_example"; // {String} namespace array is in (an organization name or user's username)
var _array = "_array_example"; // {String} name/uri of array that is url-encoded
var opts = {
'start': 56, // {Number} Start time of window of fetch logs, unix epoch in seconds (default: seven days ago)
'end': 56, // {Number} End time of window of fetch logs, unix epoch in seconds (default: current utc timestamp)
'eventTypes': "eventTypes_example", // {String} Event values can be one or more of the following read, write, create, delete, register, deregister, comma separated
'taskId': "taskId_example" // {String} Array task id To filter activity to
};
api.arrayActivityLog(namespace, _array, opts).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
Documentation for API Endpoints
All URIs are relative to http://api.tiledb.com/v1
Class | Method | HTTP request | Description |
---|---|---|---|
TiledbCloud.ArrayApi | arrayActivityLog | GET /arrays/{namespace}/{array}/activity | |
TiledbCloud.ArrayApi | createArray | POST /arrays/{namespace}/{array} | |
TiledbCloud.ArrayApi | deleteArray | DELETE /arrays/{namespace}/{array} | |
TiledbCloud.ArrayApi | deregisterArray | DELETE /arrays/{namespace}/{array}/deregister | |
TiledbCloud.ArrayApi | getAllArrayMetadata | GET /arrays | |
TiledbCloud.ArrayApi | getArray | GET /arrays/{namespace}/{array} | |
TiledbCloud.ArrayApi | getArrayMaxBufferSizes | GET /arrays/{namespace}/{array}/max_buffer_sizes | |
TiledbCloud.ArrayApi | getArrayMetaDataJson | GET /arrays/{namespace}/{array}/metadata_json | |
TiledbCloud.ArrayApi | getArrayMetadata | GET /arrays/{namespace}/{array}/metadata | |
TiledbCloud.ArrayApi | getArrayNonEmptyDomain | GET /arrays/{namespace}/{array}/non_empty_domain | |
TiledbCloud.ArrayApi | getArraySampleData | GET /arrays/{namespace}/{array}/sample | |
TiledbCloud.ArrayApi | getArraySharingPolicies | GET /arrays/{namespace}/{array}/share | |
TiledbCloud.ArrayApi | getArraysInNamespace | GET /arrays/{namespace} | |
TiledbCloud.ArrayApi | getLastAccessedArrays | GET /arrays/last_accessed | |
TiledbCloud.ArrayApi | registerArray | POST /arrays/{namespace}/{array}/register | |
TiledbCloud.ArrayApi | shareArray | PATCH /arrays/{namespace}/{array}/share | |
TiledbCloud.ArrayApi | updateArrayMetadata | PATCH /arrays/{namespace}/{array}/metadata | |
TiledbCloud.ArrayTasksApi | getArrayTasksSidebar | GET /tasks/sidebar | |
TiledbCloud.OrganizationApi | addAWSAccessCredentials | POST /credentials/{namespace}/aws | |
TiledbCloud.OrganizationApi | addUserToOrganization | POST /organizations/{organization}/user | |
TiledbCloud.OrganizationApi | checkAWSAccessCredentials | GET /credentials/{namespace}/aws | |
TiledbCloud.OrganizationApi | checkAWSAccessCredentialsByName | GET /credentials/{namespace}/aws/{name} | |
TiledbCloud.OrganizationApi | createOrganization | POST /organization | |
TiledbCloud.OrganizationApi | deleteAWSAccessCredentials | DELETE /credentials/{namespace}/aws/{name} | |
TiledbCloud.OrganizationApi | deleteOrganization | DELETE /organizations/{organization} | |
TiledbCloud.OrganizationApi | deleteUserFromOrganization | DELETE /organizations/{organization}/{username} | |
TiledbCloud.OrganizationApi | getAllOrganizations | GET /organizations | |
TiledbCloud.OrganizationApi | getOrganization | GET /organizations/{organization} | |
TiledbCloud.OrganizationApi | getOrganizationUser | GET /organizations/{organization}/{username} | |
TiledbCloud.OrganizationApi | updateAWSAccessCredentials | PATCH /credentials/{namespace}/aws/{name} | |
TiledbCloud.OrganizationApi | updateOrganization | PATCH /organizations/{organization} | |
TiledbCloud.OrganizationApi | updateUserInOrganization | PATCH /organizations/{organization}/{username} | |
TiledbCloud.QueryApi | finalizeQuery | POST /arrays/{namespace}/{array}/query/finalize | |
TiledbCloud.QueryApi | submitQuery | POST /arrays/{namespace}/{array}/query/submit | |
TiledbCloud.SqlApi | runSQL | POST /sql/{namespace} | |
TiledbCloud.StatsApi | getTiledbStats | GET /.stats | |
TiledbCloud.TasksApi | runSQL | POST /sql/{namespace} | |
TiledbCloud.TasksApi | taskIdGet | GET /task/{id} | |
TiledbCloud.TasksApi | tasksGet | GET /tasks | |
TiledbCloud.UdfApi | submitUDF | POST /arrays/{namespace}/{array}/udf/submit | |
TiledbCloud.UserApi | addAWSAccessCredentials | POST /credentials/{namespace}/aws | |
TiledbCloud.UserApi | addUserToOrganization | POST /organizations/{organization}/user | |
TiledbCloud.UserApi | checkAWSAccessCredentials | GET /credentials/{namespace}/aws | |
TiledbCloud.UserApi | checkAWSAccessCredentialsByName | GET /credentials/{namespace}/aws/{name} | |
TiledbCloud.UserApi | confirmEmail | POST /user/confirm_email | |
TiledbCloud.UserApi | createUser | POST /user | |
TiledbCloud.UserApi | deleteAWSAccessCredentials | DELETE /credentials/{namespace}/aws/{name} | |
TiledbCloud.UserApi | deleteUser | DELETE /users/{username} | |
TiledbCloud.UserApi | deleteUserFromOrganization | DELETE /organizations/{organization}/{username} | |
TiledbCloud.UserApi | getOrganizationUser | GET /organizations/{organization}/{username} | |
TiledbCloud.UserApi | getSession | GET /session | |
TiledbCloud.UserApi | getUser | GET /user | |
TiledbCloud.UserApi | getUserWithUsername | GET /users/{username} | |
TiledbCloud.UserApi | requestToken | POST /token | |
TiledbCloud.UserApi | resetUserPassword | POST /user/password_reset | |
TiledbCloud.UserApi | revokeToken | DELETE /tokens/{token} | |
TiledbCloud.UserApi | tokensGet | GET /tokens | |
TiledbCloud.UserApi | updateAWSAccessCredentials | PATCH /credentials/{namespace}/aws/{name} | |
TiledbCloud.UserApi | updateUser | PATCH /users/{username} | |
TiledbCloud.UserApi | updateUserInOrganization | PATCH /organizations/{organization}/{username} |
Documentation for Models
- TiledbCloud.AWSAccessCredentials
- TiledbCloud.ActivityEventType
- TiledbCloud.ArrayActions
- TiledbCloud.ArrayActivityLog
- TiledbCloud.ArrayInfo
- TiledbCloud.ArrayInfoUpdate
- TiledbCloud.ArrayMetadata
- TiledbCloud.ArrayMetadataEntry
- TiledbCloud.ArraySample
- TiledbCloud.ArraySchema
- TiledbCloud.ArraySharing
- TiledbCloud.ArrayTask
- TiledbCloud.ArrayTaskBrowserSidebar
- TiledbCloud.ArrayTaskData
- TiledbCloud.ArrayTaskLog
- TiledbCloud.ArrayTaskStatus
- TiledbCloud.ArrayTaskType
- TiledbCloud.ArrayType
- TiledbCloud.Attribute
- TiledbCloud.AttributeBufferHeader
- TiledbCloud.AttributeBufferSize
- TiledbCloud.Datatype
- TiledbCloud.Dimension
- TiledbCloud.DimensionCoordinate
- TiledbCloud.DimensionTileExtent
- TiledbCloud.Domain
- TiledbCloud.DomainArray
- TiledbCloud.Error
- TiledbCloud.Filter
- TiledbCloud.FilterData
- TiledbCloud.FilterOption
- TiledbCloud.FilterPipeline
- TiledbCloud.FilterType
- TiledbCloud.InlineObject
- TiledbCloud.InlineResponse200
- TiledbCloud.LastAccessedArray
- TiledbCloud.Layout
- TiledbCloud.MaxBufferSizes
- TiledbCloud.ModelArray
- TiledbCloud.NamespaceActions
- TiledbCloud.NonEmptyDomain
- TiledbCloud.Organization
- TiledbCloud.OrganizationRoles
- TiledbCloud.OrganizationUser
- TiledbCloud.PaginationMetadata
- TiledbCloud.PublicShareFilter
- TiledbCloud.Query
- TiledbCloud.QueryReader
- TiledbCloud.Querystatus
- TiledbCloud.Querytype
- TiledbCloud.ReadState
- TiledbCloud.SQLParameters
- TiledbCloud.SSOProvider
- TiledbCloud.Subarray
- TiledbCloud.SubarrayPartitioner
- TiledbCloud.SubarrayPartitionerCurrent
- TiledbCloud.SubarrayPartitionerState
- TiledbCloud.SubarrayRanges
- TiledbCloud.Token
- TiledbCloud.TokenRequest
- TiledbCloud.UDF
- TiledbCloud.UDFSubarray
- TiledbCloud.UDFSubarrayRange
- TiledbCloud.UDFType
- TiledbCloud.User
- TiledbCloud.Writer
Documentation for Authorization
ApiKeyAuth
- Type: API key
- API key parameter name: X-TILEDB-REST-API-KEY
- Location: HTTP header
BasicAuth
- Type: HTTP basic authentication
OAuth2
- Type: OAuth
- Flow: accessCode
- Authorization URL: https://oauth2.tiledb.com/oauth2/authorize
- Scopes:
- read: Grants read access
- write: Grants write access
- admin: Grants read and write access to administrative information