Skip to content

string-escape-transact-sql.md

Latest commit

 

History

History
108 lines (82 loc) · 3.51 KB

string-escape-transact-sql.md

File metadata and controls

108 lines (82 loc) · 3.51 KB
title STRING_ESCAPE (Transact-SQL)
description STRING_ESCAPE (Transact-SQL)
author MikeRayMSFT
ms.author mikeray
ms.date 02/25/2016
ms.service sql
ms.subservice t-sql
ms.topic reference
ms.custom
ignite-2025
f1_keywords
STRING_ESCAPE
STRING_ESCAPE_TSQL
helpviewer_keywords
STRING_ESCAPE function
dev_langs
TSQL
monikerRange =azuresqldb-current || >=sql-server-2016 || >=sql-server-linux-2017 || =fabric-sqldb

STRING_ESCAPE (Transact-SQL)

[!INCLUDE sqlserver2016-asdb-asdbmi-fabricsqldb]

Escapes special characters in texts and returns text with escaped characters. STRING_ESCAPE is a deterministic function, introduced in SQL Server 2016.

:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions

Syntax

STRING_ESCAPE( text , type )

Arguments

text
Is a nvarchar 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;

[!INCLUDEssResult]

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