comment

fun comment(content: String, position: Query.CommentPosition = CommentPosition.FRONT): Query

Appends an SQL comment, with content wrapped by /* */, at the specified CommentPosition in this SELECT query.

Adding some comments may be useful for tracking, embedding metadata, or for special instructions, like using /*FORCE_MASTER*/ for some cloud databases to force the statement to run in the master database or using optimizer hints.

Throws

If a comment has already been appended at the specified position. An existing comment can be removed or altered by adjustComments.

Samples

org.jetbrains.exposed.sql.tests.shared.dml.SelectTests.testSelectWithComment