mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
75 lines
1.9 KiB
XML
75 lines
1.9 KiB
XML
|
<?xml version="1.0" encoding="utf-8"?>
|
||
|
|
|
||
|
|
<!-- $Revision: 290380 $ -->
|
||
|
|
<refentry xml:id="mongodb.authenticate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||
|
|
<refnamediv>
|
||
|
|
<refname>MongoDB::authenticate</refname>
|
||
|
|
<refpurpose>Log in to this database</refpurpose>
|
||
|
|
</refnamediv>
|
||
|
|
<refsect1 role="description">
|
||
|
|
&reftitle.description;
|
||
|
|
<methodsynopsis>
|
||
|
|
<modifier>public</modifier> <type>array</type><methodname>MongoDB::authenticate</methodname>
|
||
|
|
<methodparam><type>string</type><parameter>username</parameter></methodparam>
|
||
|
|
<methodparam><type>string</type><parameter>password</parameter></methodparam>
|
||
|
|
</methodsynopsis>
|
||
|
|
<para>
|
||
|
|
This method causes its connection to be authenticated. If authentication is
|
||
|
|
enabled for the database server (it's not, by default), you need to log in
|
||
|
|
before the database will allow you to do anything.
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 role="parameters">
|
||
|
|
&reftitle.parameters;
|
||
|
|
<para>
|
||
|
|
<variablelist>
|
||
|
|
<varlistentry>
|
||
|
|
<term>
|
||
|
|
<parameter>username</parameter>
|
||
|
|
</term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
The username.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
<varlistentry>
|
||
|
|
<term>
|
||
|
|
<parameter>password</parameter>
|
||
|
|
</term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
The password (in plaintext).
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
</variablelist>
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 role="returnvalues">
|
||
|
|
&reftitle.returnvalues;
|
||
|
|
<para>
|
||
|
|
Returns database response.
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
</refentry>
|
||
|
|
<!-- Keep this comment at the end of the file
|
||
|
|
Local variables:
|
||
|
|
mode: sgml
|
||
|
|
sgml-omittag:t
|
||
|
|
sgml-shorttag:t
|
||
|
|
sgml-minimize-attributes:nil
|
||
|
|
sgml-always-quote-attributes:t
|
||
|
|
sgml-indent-step:1
|
||
|
|
sgml-indent-data:t
|
||
|
|
sgml-parent-document:nil
|
||
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
||
|
|
sgml-exposed-tags:nil
|
||
|
|
sgml-local-catalogs:nil
|
||
|
|
sgml-local-ecat-files:nil
|
||
|
|
End:
|
||
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
||
|
|
vim: et tw=78 syn=sgml
|
||
|
|
vi: ts=1 sw=1
|
||
|
|
-->
|