---
product: Chilkat
product_version: 11.7.0
language: sqlserver
language_label: SQL Server
class: Js
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/sqlserver_JsRef.html
---
# Chilkat Js — SQL Server — v11.7.0

> Chilkat 11.7.0 · language=sqlserver · class=Js
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/Js.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/sqlserver/guide.md`.

## Purpose

**Execute sandboxed JavaScript inside an application with controlled access to Chilkat features.**

Use `Chilkat.Js` when an application needs to execute JavaScript internally while retaining control over what the script is allowed to access. By default, scripts run in a closed sandbox with the JavaScript language and standard library available, but without filesystem, network, or Chilkat class access unless the host application explicitly enables those capabilities.

**Embedded JavaScript engine**

Run JavaScript code from inside the host application without launching an external scripting process.

**Sandboxed by default**

Start from a restricted execution environment and selectively expose only the capabilities the script should use.

**Enable Chilkat classes**

Allow scripts to use selected Chilkat classes when the host application wants JavaScript to perform controlled Chilkat operations.

**Filesystem restrictions**

Optionally restrict filesystem access so scripts can read or write only within approved locations.

**Script input and output**

Execute JavaScript, pass data through the host-controlled environment, and retrieve results or diagnostics from the script run.

**Controlled automation**

Use JavaScript as an embedded extension language for application-defined workflows while keeping host resources protected.

**Common pattern:** Create a `Js` object, load or provide the JavaScript code, enable only the Chilkat classes and filesystem locations the script is permitted to use, run the script, and inspect the result or diagnostic output. Use `Chilkat.Js` when the application needs scriptability with a security boundary controlled by the host.

For an extended overview, see [Js Class Overview](https://www.chilkatsoft.com/js_class_overview.asp). Also see [About the Chilkat.Js JavaScript Engine](https://www.chilkatsoft.com/chilkat_javascript_engine.asp).

**Third-Party Notice** This software includes portions of the QuickJS JavaScript engine. Copyright © 2017–2024 Fabrice Bellard. Licensed under the MIT License. The Chilkat Js engine was originally derived from QuickJS, but has been extensively modified.

## Object creation, unlocking and error handling

**Object Creation**

```sql
DECLARE @hr int
DECLARE @js int
EXEC @hr = sp_OACreate 'Chilkat.Js', @js OUT
IF @hr <> 0
BEGIN
    PRINT 'Failed to create ActiveX component'
    RETURN
END

-- ... use @js ...

EXEC @hr = sp_OADestroy @js
```

T-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (`EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;`), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `sp_OACreate 'Chilkat.Js.11'` for Chilkat v11.\*.\*.

`sp_OACreate` returns an object token (an `int`) that is passed as the first argument of every `sp_OAMethod`, `sp_OAGetProperty` and `sp_OASetProperty` call, and released with `sp_OADestroy`. Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also tokens received through an `int` OUT parameter; they must likewise be destroyed, and the OUT parameter is `NULL` when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero `@hr`), `sp_OAGetErrorInfo` describes the error.

Data types: strings are `nvarchar(4000)`; integers, booleans (1 or 0) and object tokens are `int`; dates are `datetime`. In the signatures on this page, `@success`, `@iResult`, `@sResult` and the like are the OUT variables receiving a method's return value, `@iValue` / `@sValue` receive or supply a property value, and the remaining `@` variables are the method's arguments in order.

A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example `DECLARE @tmp TABLE (outputLine ntext)` followed by `INSERT INTO @tmp EXEC sp_OAGetProperty @js, 'LastErrorText'`. See [string length limitations for strings returned by sp_OAMethod calls](https://www.chilkatsoft.com/sql_server_nvarchar_max_limitation.asp).

Methods that pass or return raw byte arrays are not shown on this page, because `varbinary(max)` values cannot be exchanged through `sp_OAMethod` (see [varbinary(max) limitation](https://www.chilkatsoft.com/sql_server_varbinary_max_limitation.asp)). Use the `BinData`-based alternatives (methods ending in *Bd*) or the base64 / hex string-encoded variants instead. Binary *properties* (such as `LastBinaryResult`) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*\*Async*) methods and event callbacks are not available from SQL Server.

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in SQL Server.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `EXEC sp_OAGetProperty @js, 'DebugLogFilePath', @sValue OUT EXEC sp_OASetProperty @js, 'DebugLogFilePath', @sValue` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastBinaryResult` | `INSERT INTO @tmp EXEC sp_OAGetProperty @js, 'LastBinaryResult'` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. |
| `LastErrorHtml` | `EXEC sp_OAGetProperty @js, 'LastErrorHtml', @sValue OUT` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `EXEC sp_OAGetProperty @js, 'LastErrorText', @sValue OUT` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `EXEC sp_OAGetProperty @js, 'LastErrorXml', @sValue OUT` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `EXEC sp_OAGetProperty @js, 'LastMethodSuccess', @iValue OUT EXEC sp_OASetProperty @js, 'LastMethodSuccess', @iValue` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `EXEC sp_OAGetProperty @js, 'LastStringResult', @sValue OUT` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `EXEC sp_OAGetProperty @js, 'LastStringResultLen', @iValue OUT` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `EXEC sp_OAGetProperty @js, 'VerboseLogging', @iValue OUT EXEC sp_OASetProperty @js, 'VerboseLogging', @iValue` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `EXEC sp_OAGetProperty @js, 'Version', @sValue OUT` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `TimeoutSeconds` | property, read/write | `EXEC sp_OAGetProperty @js, 'TimeoutSeconds', @iValue OUT EXEC sp_OASetProperty @js, 'TimeoutSeconds', @iValue` |
| `CallFunction` | method | `EXEC sp_OAMethod @js, 'CallFunction', @success OUT, @funcJson, @resultJson` |
| `ConsoleOutputSb` | method | `EXEC sp_OAMethod @js, 'ConsoleOutputSb', NULL, @sb` |
| `Eval` | method | `EXEC sp_OAMethod @js, 'Eval', @success OUT, @jscript, @resultJson` |
| `SetCkPermission` | method | `EXEC sp_OAMethod @js, 'SetCkPermission', @success OUT, @chilkatClassName, @permission` |

## Properties

### Js.TimeoutSeconds

`Chilkat 11.7.0 · sqlserver · Js · TimeoutSeconds · property · read/write · since 11.4.0`

```sql
EXEC sp_OAGetProperty @js, 'TimeoutSeconds', @iValue OUT
EXEC sp_OASetProperty @js, 'TimeoutSeconds', @iValue
```

Specify a timeout in seconds to prevent JavaScript from running indefinitely, such as in an infinite loop. By default, the value is 0, meaning no timeout is set and infinite loops will continue forever.

## Methods

### Js.CallFunction

`Chilkat 11.7.0 · sqlserver · Js · CallFunction · method · since 11.4.0`

```sql
EXEC sp_OAMethod @js, 'CallFunction', @success OUT, @funcJson, @resultJson
```

Calls a JavaScript function. The function name and arguments are passed in `funcJson`. The result is returned in `resultJson`.

Returns 1 for success, 0 for failure.

### Js.ConsoleOutputSb

`Chilkat 11.7.0 · sqlserver · Js · ConsoleOutputSb · method · since 11.4.0`

```sql
EXEC sp_OAMethod @js, 'ConsoleOutputSb', NULL, @sb
```

Returns the console output in `sb` from the last call to `Eval` .

### Js.Eval

`Chilkat 11.7.0 · sqlserver · Js · Eval · method · since 11.4.0`

```sql
EXEC sp_OAMethod @js, 'Eval', @success OUT, @jscript, @resultJson
```

Run `jscript` as a script. Return output and errors in `resultJson`.

Returns 1 for success, 0 for failure.

### Js.SetCkPermission

`Chilkat 11.7.0 · sqlserver · Js · SetCkPermission · method · since 11.4.0`

```sql
EXEC sp_OAMethod @js, 'SetCkPermission', @success OUT, @chilkatClassName, @permission
```

Sets sandbox related permissions for Chilkat objects. The `chilkatClassName` is the name of the Chilkat class (case-insensitive), such as `Http`, `Rest`, `"MailMan"`, `"Ftp2"`, `"Ssh"`, etc. The `chilkatClassName` can also be set to `"all"` to apply the permission to all Chilkat classes.

Possible values for `permission` are:

- `disable` - Your JavaScript code is not allowed to create an instance of the Chilkat class. A JavaScript exception is thrown when trying to create a Chilkat object of a class that is disabled.
- `sandbox` - Objects for the Chilkat class can be instantiated in JavaScript, but they have no read or write access to the local filesystem.
- `readOnly` - Objects for the Chilkat class can be instantiated in JavaScript and have read-only access to the local filesystem.
- `writeOnly` - Objects for the Chilkat class can be instantiated in JavaScript and have write-only access to the local filesystem.
- `readWrite` - Objects for the Chilkat class can be instantiated in JavaScript and have read/write access to the local filesystem.

By default, all Chilkat classes are **disabled**. Your application must enable `"all"` or specific Chilkat classes before calling `Eval` or `CallFunction` .

Returns 1 for success, 0 for failure.

## Events and callbacks

This binding has no event callbacks.

## Related classes

[`JsonObject`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/sqlserver/classes/JsonObject.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/sqlserver/classes/StringBuilder.md)

