STRING_ESCAPE (Transact-SQL)

THIS TOPIC APPLIES TO: yesSQL Server (starting with 2016)yesAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

Escapes special characters in texts and returns text with escaped characters. STRING_ESCAPE is a deterministic function.

Topic link icon Transact-SQL Syntax Conventions

Syntax

STRING_ESCAPE( text , type )  

Arguments

text
Is a nvarcharexpression expression representing the object that should be escaped.

type
Escaping rules that will be applied. Currently the value supported is 'json'.

Return Types

nvarchar(max) text with escaped special and control characters. Currently STRING_ESCAPE can only escape JSON special characters shown in the following tables.

Special character Encoded sequence
Quotation mark (") \"
Reverse solidus (\) \\
Solidus (/) \/
Backspace \b
Form feed \f
New line \n
Carriage return \r
Horizontal tab \t
Control character Encoded sequence
CHAR(0) \u0000
CHAR(1) \u0001
... ...
CHAR(31) \u001f

Remarks

Examples

A. Escape text according to the JSON formatting rules

The following query escapes special characters using JSON rules and returns escaped text.

SELECT STRING_ESCAPE('\   /  
\\    "     ', 'json') AS escapedText;  

Here is the result set.

escapedText

-------------------------------------------------------------

\\\t\/\n\\\\\t\"\t

B. Format JSON object

The following query creates JSON text from number and string variables, and escapes any special JSON character in variables.

SET @json = FORMATMESSAGE('{ "id": %d,"name": "%s", "surname": "%s" }',   
    17, STRING_ESCAPE(@name,'json'), STRING_ESCAPE(@surname,'json') );  

See Also

String Functions (Transact-SQL)
SUBSTRING (Transact-SQL)