supported-commands.md

sidebar_position	description
1	This is a list of all supported commands in FerretDB

Supported commands

Query commands

Command	Argument	Status	Comments
delete		✅	Basic command is fully supported
	deletes	✅
	comment	⚠️
	let	⚠️	Unimplemented
	ordered	✅
	writeConcern	⚠️	Ignored
	q	✅
	limit	✅
	collation	❌	Unimplemented
	hint	⚠️	Ignored
find		✅	Basic command is fully supported
	filter	✅
	sort	✅
	projection	✅	Basic projections with fields are supported
	hint	⚠️	Ignored
	skip	⚠️
	limit	✅
	batchSize	✅
	singleBatch	✅
	comment	⚠️
	maxTimeMS	✅
	readConcern	⚠️	Ignored
	max	⚠️	Ignored
	min	⚠️	Ignored
	returnKey	❌	Unimplemented
	showRecordId	✅
	tailable	✅
	oplogReplay	⚠️	Ignored
	noCursorTimeout	❌	Issue
	awaitData	✅
	allowPartialResults	❌	Unimplemented
	collation	❌	Unimplemented
	allowDiskUse	⚠️	Ignored
	let	❌	Unimplemented
findAndModify		✅	Basic command is fully supported
	query	✅
	sort	✅
	remove	✅
	update	✅
	new	✅
	upsert	✅
	bypassDocumentValidation	⚠️	Ignored
	writeConcern	⚠️	Ignored
	maxTimeMS	✅
	collation	❌	Unimplemented
	arrayFilters	❌	Unimplemented
	hint	⚠️	Ignored
	comment	⚠️
	let	⚠️	Unimplemented
getMore		✅	Basic command is fully supported
	batchSize	✅
	maxTimeMS	✅
	comment	⚠️	Unimplemented
insert		✅	Basic command is fully supported
	documents	✅
	ordered	✅
	bypassDocumentValidation	⚠️	Ignored
	comment	⚠️	Ignored
update		✅	Basic command is fully supported
	updates	✅
	ordered	⚠️	Ignored
	writeConcern	⚠️	Ignored
	bypassDocumentValidation	⚠️	Ignored
	comment	⚠️
	let	⚠️	Unimplemented
	q	✅
	u	⚠️	Issue
	c	⚠️	Unimplemented
	upsert	✅
	multi	✅
	collation	❌	Unimplemented
	arrayFilters	⚠️	Unimplemented
	hint	⚠️	Ignored

Update Operators

The following operators and modifiers are available in the update and findAndModify commands.

Operator	Modifier	Status	Comments
$currentDate		✅
$inc		✅
$min		✅
$max		✅
$mul		✅
$rename		✅
$set		✅
$setOnInsert		✅
$unset		✅
$		⚠️	Issue
$[]		⚠️	Issue
$[<identifier>]		⚠️	Issue
$addToSet		✅️
$pop		✅
$pull		⚠️	Issue
$push		✅️
$pullAll		✅️
	$each	✅️
	$position	⚠️	Issue
	$slice	⚠️	Issue
	$sort	⚠️	Issue
	$bit	✅️

Projection Operators

The following operators are available in the find command projection argument.

Operator	Status	Comments
$	✅️
$elemMatch	❌	Issue
$meta	❌	Issue
$slice	❌	Issue

Query Plan Cache Commands

Related issue.

Command	Argument	Status	Comments
planCacheClear		❌	Issue
	query	⚠️
	projection	⚠️
	sort	⚠️
	comment	⚠️
planCacheClearFilters		❌	Issue
	query	⚠️
	sort	⚠️
	projection	⚠️
	collation	❌	Unimplemented
	comment	⚠️
planCacheListFilters		❌	Issue
	comment	⚠️
planCacheSetFilter		❌	Issue
	query	⚠️
	sort	⚠️
	projection	⚠️
	collation	❌	Unimplemented
	indexes	⚠️
	comment	⚠️

Free Monitoring Commands

Command	Argument	Status	Comments
setFreeMonitoring		✅	Telemetry reporting
	action: "enable"	✅	--telemetry=enable
	action: "disable"	✅	--telemetry=disable
getFreeMonitoringStatus		✅

Database Operations

User Management Commands

Command	Argument	Status	Comments
createUser		✅
	pwd	⚠️
	customData	⚠️
	roles	⚠️
	digestPassword	⚠️
	writeConcern	⚠️
	authenticationRestrictions	⚠️
	mechanisms	⚠️
	digestPassword	⚠️
	comment	⚠️
dropAllUsersFromDatabase		✅
	writeConcern	⚠️
	comment	⚠️
dropUser		✅
	writeConcern	⚠️
	comment	⚠️
grantRolesToUser		❌	Issue
	writeConcern	⚠️
	comment	⚠️
revokeRolesFromUser		❌	Issue
	roles	⚠️
	writeConcern	⚠️
	comment	⚠️
updateUser		❌	Issue
	pwd	⚠️
	customData	⚠️
	roles	⚠️
	digestPassword	⚠️
	writeConcern	⚠️
	authenticationRestrictions	⚠️
	mechanisms	⚠️
	digestPassword	⚠️
	comment	⚠️
usersInfo		✅
	showCredentials	⚠️
	showCustomData	⚠️
	showPrivileges	⚠️
	showAuthenticationRestrictions	⚠️
	filter	⚠️	Issue
	comment	⚠️

Authentication Commands

Command	Argument	Status	Comments
authenticate		❌	Issue
getnonce		❌	Deprecated
logout		✅
saslStart		✅

Role Management Commands

Command	Argument	Status	Comments
createRole		❌	Issue
	privileges	⚠️
	roles	⚠️
	authenticationRestrictions	⚠️
	writeConcern	⚠️
	comment	⚠️
dropRole		❌	Issue
	writeConcern	⚠️
	comment	⚠️
dropAllRolesFromDatabase		❌	Issue
	writeConcern	⚠️
	comment	⚠️
grantPrivilegesToRole		❌	Issue
	privileges	⚠️
	writeConcern	⚠️
	comment	⚠️
grantRolesToRole		❌	Issue
	roles	⚠️
	writeConcern	⚠️
	comment	⚠️
invalidateUserCache		❌	Issue
revokePrivilegesFromRole		❌	Issue
	privileges	⚠️
	writeConcern	⚠️
	comment	⚠️
revokeRolesFromRole		❌	Issue
	roles	⚠️
	writeConcern	⚠️
	comment	⚠️
rolesInfo		❌	Issue
	showPrivileges	⚠️
	showBuiltinRoles	⚠️
	comment	⚠️
updateRole		❌	Issue
	privileges	⚠️
	roles	⚠️
	authenticationRestrictions	⚠️
	writeConcern	⚠️
	comment	⚠️

Replication Commands

Command	Argument	Status	Comments
replSetInitiate		❌	Issue

Session Commands

Related issue.

Related issue.

Command	Argument	Status	Comments
abortTransaction		❌	Issue
	txnNumber	⚠️
	writeConcern	⚠️
	autocommit	⚠️
	comment	⚠️
commitTransaction		❌	Issue
	txnNumber	⚠️
	writeConcern	⚠️
	autocommit	⚠️
	comment	⚠️
endSessions		❌	Issue
killAllSessions		❌	Issue
killAllSessionsByPattern		❌	Issue
killSessions		❌	Issue
refreshSessions		❌	Issue
startSession		❌	Issue

Aggregation pipelines

Related issue.

Command	Argument	Status	Comments
aggregate		✅️
count		✅
distinct		✅

Aggregation pipeline stages

Stage	Status	Comments
$addFields	⚠️	Issue
$bucket	❌	Issue
$bucketAuto	❌	Issue
$changeStream	❌	Issue
$changeStream	❌	Issue
$collStats	⚠️	Issue
$count	✅️
$currentOp	❌	Issue
$densify	❌	Issue
$documents	❌	Issue
$documents	❌	Issue
$facet	❌	Issue
$fill	❌	Issue
$geoNear	❌	Issue
$graphLookup	❌	Issue
$group	✅️
$indexStats	❌	Issue
$limit	✅️
$listLocalSessions	❌	Issue
$listSessions	❌	Issue
$lookup	❌	Issue
$match	✅
$merge	❌	Issue
$out	❌	Issue
$planCacheStats	❌	Issue
$project	✅
$redact	❌	Issue
$replaceRoot	❌	Issue
$replaceWith	❌	Issue
$sample	❌	Issue
$search	❌	Issue
$searchMeta	❌	Issue
$set	⚠️	Issue
$setWindowFields	❌	Issue
$skip	✅️
$sort	✅️
$sortByCount	❌	Issue
$unionWith	❌	Issue
$unset	✅️
$unwind	✅️

Aggregation pipeline operators

Operator	Status	Comments
$abs	❌	Issue
$accumulator	❌	Issue
$acos	❌	Issue
$acosh	❌	Issue
$add (arithmetic)	❌	Issue
$add (date)	❌	Issue
$addToSet	❌	Issue
$allElementsTrue	❌	Issue
$and	❌	Issue
$anyElementTrue	❌	Issue
$arrayElemAt	❌	Issue
$arrayToObject	❌	Issue
$asin	❌	Issue
$asinh	❌	Issue
$atan	❌	Issue
$atan2	❌	Issue
$atanh	❌	Issue
$avg	❌	Issue
$binarySize	❌	Issue
$bottom	❌	Issue
$bottomN	❌	Issue
$bsonSize	❌	Issue
$ceil	❌	Issue
$cmp	❌	Issue
$concat	❌	Issue
$concatArrays	❌	Issue
$cond	❌	Issue
$convert	❌	Issue
$cos	❌	Issue
$cosh	❌	Issue
$count	✅️
$covariancePop	❌	Issue
$covarianceSamp	❌	Issue
$dateAdd	❌	Issue
$dateDiff	❌	Issue
$dateFromParts	❌	Issue
$dateFromString	❌	Issue
$dateSubtract	❌	Issue
$dateToParts	❌	Issue
$dateToString	❌	Issue
$dateTrunc	❌	Issue
$dayOfMonth	❌	Issue
$dayOfWeek	❌	Issue
$dayOfYear	❌	Issue
$degreesToRadians	❌	Issue
$denseRank	❌	Issue
$derivative	❌	Issue
$divide	❌	Issue
$documentNumber	❌	Issue
$eq	❌	Issue
$exp	❌	Issue
$expMovingAvg	❌	Issue
$filter	❌	Issue
$first (accumulator)	❌	Issue
$first (array operator)	❌	Issue
$firstN	❌	Issue
$floor	❌	Issue
$function	❌	Issue
$getField	❌	Issue
$gt	❌	Issue
$gte	❌	Issue
$hour	❌	Issue
$ifNull	❌	Issue
$in	❌	Issue
$indexOfArray	❌	Issue
$indexOfBytes	❌	Issue
$indexOfCP	❌	Issue
$integral	❌	Issue
$isArray	❌	Issue
$isNumber	❌	Issue
$isoDayOfWeek	❌	Issue
$isoWeek	❌	Issue
$isoWeekYear	❌	Issue
$last (accumulator)	❌	Issue
$last (array operator)	❌	Issue
$lastN	❌	Issue
$let	❌	Issue
$linearFill	❌	Issue
$literal	❌	Issue
$ln	❌	Issue
$locf	❌	Issue
$log	❌	Issue
$log10	❌	Issue
$lt	❌	Issue
$lte	❌	Issue
$ltrim	❌	Issue
$map	❌	Issue
$max	❌	Issue
$maxN	❌	Issue
$mergeObjects	❌	Issue
$meta	❌	Issue
$millisecond	❌	Issue
$min	❌	Issue
$minN	❌	Issue
$minute	❌	Issue
$mod	❌	Issue
$month	❌	Issue
$multiply	❌	Issue
$ne	❌	Issue
$not	❌	Issue
$objectToArray	❌	Issue
$or	❌	Issue
$pow	❌	Issue
$push	❌	Issue
$radiansToDegrees	❌	Issue
$rand	❌	Issue
$range	❌	Issue
$rank	❌	Issue
$reduce	❌	Issue
$regexFind	❌	Issue
$regexFindAll	❌	Issue
$regexMatch	❌	Issue
$replaceAll	❌	Issue
$replaceOne	❌	Issue
$reverseArray	❌	Issue
$round	❌	Issue
$rtrim	❌	Issue
$sampleRate	❌	Issue
$second	❌	Issue
$setDifference	❌	Issue
$setEquals	❌	Issue
$setField	❌	Issue
$setIntersection	❌	Issue
$setIsSubset	❌	Issue
$setUnion	❌	Issue
$shift	❌	Issue
$sin	❌	Issue
$sinh	❌	Issue
$size	❌	Issue
$slice	❌	Issue
$sortArray	❌	Issue
$split	❌	Issue
$sqrt	❌	Issue
$stdDevPop	❌	Issue
$stdDevSamp	❌	Issue
$strcasecmp	❌	Issue
$strLenBytes	❌	Issue
$strLenCP	❌	Issue
$substr	❌	Issue
$substrBytes	❌	Issue
$substrCP	❌	Issue
$subtract (arithmetic)	❌	Issue
$subtract (date)	❌	Issue
$sum (accumulator)	✅️
$sum (operator)	❌	Issue
$switch	❌	Issue
$tan	❌	Issue
$tanh	❌	Issue
$toBool	❌	Issue
$toDate	❌	Issue
$toDecimal	❌	Issue
$toDouble	❌	Issue
$toInt	❌	Issue
$toLong	❌	Issue
$toLower	❌	Issue
$toObjectId	❌	Issue
$top	❌	Issue
$topN	❌	Issue
$toString	❌	Issue
$toUpper	❌	Issue
$trim	❌	Issue
$trunc	❌	Issue
$tsIncrement	❌	Issue
$tsSecond	❌	Issue
$type	❌	Issue
$unsetField	❌	Issue
$week	❌	Issue
$year	❌	Issue
$zip	❌	Issue

Administration commands

Command	Argument / Option	Property	Status	Comments
cloneCollectionAsCapped			❌
	toCollection		⚠️
	size		⚠️
	writeConcern		⚠️
	comment		⚠️
collMod			❌	Issue
	index		⚠️
		keyPattern	⚠️
		name	⚠️
		expireAfterSeconds	⚠️
		hidden	⚠️
		prepareUnique	⚠️
		unique	⚠️
	validator		⚠️
		validationLevel	⚠️
		validationAction	⚠️
	viewOn (Views)		⚠️
	pipeline (Views)		⚠️
	cappedSize		⚠️
	cappedMax		⚠️
	changeStreamPreAndPostImages		⚠️
compact			✅
	force		✅
	comment		⚠️
compactStructuredEncryptionData			❌
	compactionTokens		⚠️
convertToCapped			❌	Issue
	size		⚠️
	writeConcern		⚠️
	comment		⚠️
create			✅
	capped		✅️
	timeseries		⚠️	Issue
		timeField	⚠️
		metaField	⚠️
		granularity	⚠️
	expireAfterSeconds		⚠️	Issue
	clusteredIndex		⚠️
	changeStreamPreAndPostImages		⚠️
	autoIndexId		⚠️	Issue
	size		✅️
	max		✅
	storageEngine		⚠️	Ignored
	validator		⚠️	Not implemented in PostgreSQL
	validationLevel		⚠️	Unimplemented
	validationAction		⚠️	Unimplemented
	indexOptionDefaults		⚠️	Ignored
	viewOn		⚠️	Unimplemented
	pipeline		⚠️	Unimplemented
	collation		❌	Unimplemented
	writeConcern		⚠️	Ignored
	encryptedFields		⚠️
	comment		⚠️	Ignored
createIndexes			✅
	indexes		✅
		key	✅
		name	✅️
		unique	✅
		partialFilterExpression	❌	Issue
		sparse	❌	Issue
		expireAfterSeconds	❌	Issue
		hidden	❌	Unimplemented
		storageEngine	❌	Unimplemented
		weights	❌	Unimplemented
		default_language	❌	Unimplemented
		language_override	❌	Unimplemented
		textIndexVersion	❌	Unimplemented
		2dsphereIndexVersion	❌	Unimplemented
		bits	❌	Unimplemented
		min	❌	Unimplemented
		max	❌	Unimplemented
		bucketSize	❌	Unimplemented
		collation	❌	Unimplemented
		wildcardProjection	❌	Unimplemented
	writeConcern		⚠️
	commitQuorum		⚠️
	comment		⚠️
currentOp			❌	Issue
	$ownOps		⚠️
	$all		⚠️
	comment		⚠️
drop			✅
	writeConcern		⚠️	Ignored
	comment		⚠️	Ignored
dropDatabase			✅
	writeConcern		⚠️	Ignored
	comment		⚠️	Ignored
dropConnections			❌	Issue
	hostAndPort		⚠️
	comment		⚠️
dropIndexes			✅
	index		✅
	writeConcern		⚠️	Ignored
	comment		⚠️	Ignored
filemd5			❌
fsync			❌
fsyncUnlock			❌
	lock		⚠️
	comment		⚠️
getDefaultRWConcern			❌
	inMemory		⚠️
	comment		⚠️
getClusterParameter			❌
getParameter			❌
	comment		⚠️
killCursors			✅
	cursors		✅
	comment		⚠️
killOp			❌	Issue
	op		⚠️
	comment		⚠️
listCollections			✅
	filter		✅
	nameOnly		⚠️	Issue
	authorizedCollections		⚠️	Issue
	comment		⚠️
listDatabases			✅
	filter		✅
	nameOnly		✅
	authorizedDatabases		⚠️	Issue
	comment		⚠️	Ignored
listIndexes			✅
	cursor.batchSize		⚠️	Ignored
	comment		⚠️	Ignored
logRotate			❌	Issue
	<target>		⚠️
	comment		⚠️
reIndex			❌	Issue
renameCollection			✅
	to		✅	Issue
	dropTarget		⚠️	Issue
	writeConcern		⚠️	Ignored
	comment		⚠️	Ignored
rotateCertificates			❌
setFeatureCompatibilityVersion			❌
setIndexCommitQuorum			❌
	setIndexCommitQuorum		⚠️
	indexNames		⚠️
	commitQuorum		⚠️
	comment		⚠️
setParameter			❌	Issue
setDefaultRWConcern			❌
	defaultReadConcern		⚠️
	defaultWriteConcern		⚠️
	writeConcern		⚠️
	comment		⚠️
shutdown			❌	Issue
	force		⚠️
	timeoutSecs		⚠️
	comment		⚠️

Diagnostic commands

Command	Argument	Status	Comments
buildInfo		✅	Basic command is fully supported
collStats		✅	Basic command is fully supported
	collStats	✅
	scale	✅
connPoolStats		❌	Unimplemented
connectionStatus		✅	Basic command is fully supported
	showPrivileges	✅
dataSize		✅	Basic command is fully supported
	keyPattern	⚠️	Unimplemented
	min	⚠️	Unimplemented
	max	⚠️	Unimplemented
	estimate	⚠️	Ignored
dbHash		❌	Unimplemented
	collection	⚠️
dbStats		✅	Basic command is fully supported
	scale	✅
	freeStorage	⚠️	Unimplemented
driverOIDTest		⚠️	Unimplemented
explain		✅	Basic command is fully supported
	verbosity	⚠️	Ignored
	comment	⚠️	Unimplemented
features		❌	Unimplemented
getCmdLineOpts		✅	Basic command is fully supported
getLog		✅	Basic command is fully supported
hostInfo		✅	Basic command is fully supported
_isSelf		❌	Unimplemented
listCommands		✅	Basic command is fully supported
lockInfo		❌	Unimplemented
netstat		❌	Unimplemented
ping		✅	Basic command is fully supported
profile		❌	Unimplemented
	slowms	⚠️
	sampleRate	⚠️
	filter	⚠️
serverStatus		✅	Basic command is fully supported
shardConnPoolStats		❌	Unimplemented
top		❌	Unimplemented
validate		✅	Basic command is fully supported
	full	⚠️
	repair	⚠️
	metadata	⚠️
	checkBSONConformance	⚠️
validateDBMetadata		❌	Unimplemented
	apiParameters	⚠️
	db	⚠️
	collections	⚠️
whatsmyuri		✅	Basic command is fully supported