0.0.2 • Published 4 years ago

alekshs-test2 v0.0.2

Weekly downloads
-
License
MIT
Repository
-
Last release
4 years ago

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

ClassMethodHTTP requestDescription
TiledbCloud.ArrayApiarrayActivityLogGET /arrays/{namespace}/{array}/activity
TiledbCloud.ArrayApicreateArrayPOST /arrays/{namespace}/{array}
TiledbCloud.ArrayApideleteArrayDELETE /arrays/{namespace}/{array}
TiledbCloud.ArrayApideregisterArrayDELETE /arrays/{namespace}/{array}/deregister
TiledbCloud.ArrayApigetAllArrayMetadataGET /arrays
TiledbCloud.ArrayApigetArrayGET /arrays/{namespace}/{array}
TiledbCloud.ArrayApigetArrayMaxBufferSizesGET /arrays/{namespace}/{array}/max_buffer_sizes
TiledbCloud.ArrayApigetArrayMetaDataJsonGET /arrays/{namespace}/{array}/metadata_json
TiledbCloud.ArrayApigetArrayMetadataGET /arrays/{namespace}/{array}/metadata
TiledbCloud.ArrayApigetArrayNonEmptyDomainGET /arrays/{namespace}/{array}/non_empty_domain
TiledbCloud.ArrayApigetArraySampleDataGET /arrays/{namespace}/{array}/sample
TiledbCloud.ArrayApigetArraySharingPoliciesGET /arrays/{namespace}/{array}/share
TiledbCloud.ArrayApigetArraysInNamespaceGET /arrays/{namespace}
TiledbCloud.ArrayApigetLastAccessedArraysGET /arrays/last_accessed
TiledbCloud.ArrayApiregisterArrayPOST /arrays/{namespace}/{array}/register
TiledbCloud.ArrayApishareArrayPATCH /arrays/{namespace}/{array}/share
TiledbCloud.ArrayApiupdateArrayMetadataPATCH /arrays/{namespace}/{array}/metadata
TiledbCloud.ArrayTasksApigetArrayTasksSidebarGET /tasks/sidebar
TiledbCloud.OrganizationApiaddAWSAccessCredentialsPOST /credentials/{namespace}/aws
TiledbCloud.OrganizationApiaddUserToOrganizationPOST /organizations/{organization}/user
TiledbCloud.OrganizationApicheckAWSAccessCredentialsGET /credentials/{namespace}/aws
TiledbCloud.OrganizationApicheckAWSAccessCredentialsByNameGET /credentials/{namespace}/aws/{name}
TiledbCloud.OrganizationApicreateOrganizationPOST /organization
TiledbCloud.OrganizationApideleteAWSAccessCredentialsDELETE /credentials/{namespace}/aws/{name}
TiledbCloud.OrganizationApideleteOrganizationDELETE /organizations/{organization}
TiledbCloud.OrganizationApideleteUserFromOrganizationDELETE /organizations/{organization}/{username}
TiledbCloud.OrganizationApigetAllOrganizationsGET /organizations
TiledbCloud.OrganizationApigetOrganizationGET /organizations/{organization}
TiledbCloud.OrganizationApigetOrganizationUserGET /organizations/{organization}/{username}
TiledbCloud.OrganizationApiupdateAWSAccessCredentialsPATCH /credentials/{namespace}/aws/{name}
TiledbCloud.OrganizationApiupdateOrganizationPATCH /organizations/{organization}
TiledbCloud.OrganizationApiupdateUserInOrganizationPATCH /organizations/{organization}/{username}
TiledbCloud.QueryApifinalizeQueryPOST /arrays/{namespace}/{array}/query/finalize
TiledbCloud.QueryApisubmitQueryPOST /arrays/{namespace}/{array}/query/submit
TiledbCloud.SqlApirunSQLPOST /sql/{namespace}
TiledbCloud.StatsApigetTiledbStatsGET /.stats
TiledbCloud.TasksApirunSQLPOST /sql/{namespace}
TiledbCloud.TasksApitaskIdGetGET /task/{id}
TiledbCloud.TasksApitasksGetGET /tasks
TiledbCloud.UdfApisubmitUDFPOST /arrays/{namespace}/{array}/udf/submit
TiledbCloud.UserApiaddAWSAccessCredentialsPOST /credentials/{namespace}/aws
TiledbCloud.UserApiaddUserToOrganizationPOST /organizations/{organization}/user
TiledbCloud.UserApicheckAWSAccessCredentialsGET /credentials/{namespace}/aws
TiledbCloud.UserApicheckAWSAccessCredentialsByNameGET /credentials/{namespace}/aws/{name}
TiledbCloud.UserApiconfirmEmailPOST /user/confirm_email
TiledbCloud.UserApicreateUserPOST /user
TiledbCloud.UserApideleteAWSAccessCredentialsDELETE /credentials/{namespace}/aws/{name}
TiledbCloud.UserApideleteUserDELETE /users/{username}
TiledbCloud.UserApideleteUserFromOrganizationDELETE /organizations/{organization}/{username}
TiledbCloud.UserApigetOrganizationUserGET /organizations/{organization}/{username}
TiledbCloud.UserApigetSessionGET /session
TiledbCloud.UserApigetUserGET /user
TiledbCloud.UserApigetUserWithUsernameGET /users/{username}
TiledbCloud.UserApirequestTokenPOST /token
TiledbCloud.UserApiresetUserPasswordPOST /user/password_reset
TiledbCloud.UserApirevokeTokenDELETE /tokens/{token}
TiledbCloud.UserApitokensGetGET /tokens
TiledbCloud.UserApiupdateAWSAccessCredentialsPATCH /credentials/{namespace}/aws/{name}
TiledbCloud.UserApiupdateUserPATCH /users/{username}
TiledbCloud.UserApiupdateUserInOrganizationPATCH /organizations/{organization}/{username}

Documentation for Models

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
0.0.2

4 years ago

0.0.1

4 years ago