Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MONGOC_DATABASE_COMMAND_SIMPLE(3)  libmongoc MONGOC_DATABASE_COMMAND_SIMPLE(3)

SYNOPSIS
	  bool
	  mongoc_database_command_simple (mongoc_database_t *database,
					  const	bson_t *command,
					  const	mongoc_read_prefs_t *read_prefs,
					  bson_t *reply,
					  bson_error_t *error);

PARAMETERS
        database: A mongoc_database_t.

        command: A bson_t containing the command.

        read_prefs:  An  optional mongoc_read_prefs_t.	Otherwise, the command
	 uses mode MONGOC_READ_PRIMARY.

        reply:	A maybe-NULL pointer to	overwritable storage for a  bson_t  to
	 contain the results.

        error:	An optional location for a bson_error_t	or NULL.

       This  is	 a  simplified interface to mongoc_database_command() that re-
       turns the first result document.	The database's read  preference,  read
       concern,	and write concern are not applied to the command.  The parame-
       ter  reply  is initialized even upon failure to simplify	memory manage-
       ment.

       This function is	not considered a retryable read	operation.

ERRORS
       Errors are propagated through the error parameter.

RETURNS
       Returns true if successful. Returns false and sets error	if  there  are
       invalid arguments or a server or	network	error.

       This  function  does  not check the server response for a write concern
       error or	write concern timeout.

AUTHOR
       MongoDB,	Inc

COPYRIGHT
       2009-present, MongoDB, Inc.

1.30.2				 Apr 12, 2025MONGOC_DATABASE_COMMAND_SIMPLE(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mongoc_database_command_simple&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help