{"id":43890,"library":"sql-data-api","title":"sql-data-api","description":"Javascript client for Worksheet Systems SQL Data API, version 0.3.14. Enables querying and saving data to SQL databases via REST API with authentication support (user/password or access token). Supports table queries with filtering, sorting, pagination, joins, and aggregation; also provides insert/update/delete operations. Includes TypeScript definitions. Release cadence is irregular; appears active.","status":"active","version":"0.3.14","language":"javascript","source_language":"en","source_url":"https://github.com/FalconSoft/sql-data-api-client-js","tags":["javascript","sql","api","typescript"],"install":[{"cmd":"npm install sql-data-api","lang":"bash","label":"npm"},{"cmd":"yarn add sql-data-api","lang":"bash","label":"yarn"},{"cmd":"pnpm add sql-data-api","lang":"bash","label":"pnpm"}],"dependencies":[],"imports":[{"note":"ESM only; named export, not default.","wrong":"const sqlDataApi = require('sql-data-api')","symbol":"sqlDataApi","correct":"import { sqlDataApi } from 'sql-data-api'"},{"note":"Named export, not default.","wrong":"import setBaseUrl from 'sql-data-api'","symbol":"setBaseUrl","correct":"import { setBaseUrl } from 'sql-data-api'"},{"note":"Named export, not default. Returns a promise.","wrong":"import authenticate from 'sql-data-api'","symbol":"authenticate","correct":"import { authenticate } from 'sql-data-api'"},{"note":"Named export, not default. Use token from app.worksheet.systems.","wrong":"import setUserAccessToken from 'sql-data-api'","symbol":"setUserAccessToken","correct":"import { setUserAccessToken } from 'sql-data-api'"}],"quickstart":{"code":"import { setBaseUrl, setUserAccessToken, sqlDataApi } from 'sql-data-api';\n\nsetBaseUrl('https://api.worksheet.systems');\nconst token = process.env.ACCESS_TOKEN ?? '';\nsetUserAccessToken(token);\n\nasync function getUsers() {\n  const data = await sqlDataApi('myConnection')\n    .query('Users', 'Id, Name, Email', {\n      filter: \"Status = 'active'\",\n      top: 10\n    });\n  console.log(data);\n}\ngetUsers();","lang":"typescript","description":"Sets base URL and access token, then queries first 10 active users from the 'Users' table."},"warnings":[{"fix":"Call setBaseUrl() at app initialization.","message":"setBaseUrl() must be called before any query or save operation.","severity":"gotcha","affected_versions":">=0.1.0"},{"fix":"Use setUserAccessToken with a token generated from Worksheet Systems account settings.","message":"Access token must be set via setUserAccessToken() before authentication; password authentication is less secure.","severity":"gotcha","affected_versions":">=0.1.0"},{"fix":"Update query calls to use new signature if they passed an object as second argument.","message":"In version 0.2.x, the query() method signature changed: second parameter is now fieldsOrQuery (string or SqlReadQueryInfo) instead of just string.","severity":"breaking","affected_versions":">=0.2.0"},{"fix":"Replace authenticate(username, password) with setUserAccessToken(token).","message":"The authenticate() function is deprecated; use setUserAccessToken() instead.","severity":"deprecated","affected_versions":">=0.3.0"}],"env_vars":null,"search_vec":"'0.3.14':14 'access':31 'activ':55 'aggreg':42 'also':43 'api':4,12,25,58 'appear':54 'authent':27 'cadenc':51 'client':6 'data':3,11,19 'databas':22 'definit':49 'enabl':15 'filter':37 'includ':47 'insert/update/delete':45 'irregular':53 'javascript':5,56 'join':40 'oper':46 'pagin':39 'provid':44 'queri':16,35 'releas':50 'rest':24 'save':18 'sort':38 'sql':2,10,21,57 'sql-data-api':1 'support':28,33 'system':9 'tabl':34 'token':32 'typescript':48,59 'user/password':29 'version':13 'via':23 'worksheet':8","created_at":"2026-06-05T17:01:58.558155+00:00","updated_at":"2026-06-05T17:01:58.558155+00:00","problems":[{"fix":"Use: import { sqlDataApi } from 'sql-data-api'","cause":"Importing as default instead of named import.","error":"TypeError: sqlDataApi is not a function"},{"fix":"Call setBaseUrl('https://api.worksheet.systems') at the top of your script.","cause":"setBaseUrl() was not called before operations.","error":"Error: Base URL not set"},{"fix":"Verify the connection name is correct and exists in your Worksheet Systems account.","cause":"The connection name passed to sqlDataApi() does not exist.","error":"Error: 'connectionName' not found"}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":"https://github.com/FalconSoft/sql-data-api-client-js","github":"https://github.com/FalconSoft/sql-data-api-client-js","docs":null,"changelog":null,"pypi":null,"npm":"sql-data-api","openapi_spec":null,"status_page":null,"smithery":null,"categories":["database"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-05","next_check":"2026-09-03","install_tag":null}}