getParameter(데이터베이스 명령)

정의

getParameter: getParameter is an administrative command for retrieving the values of parameters. Use the db.adminCommand( { command } ) method to run the getParameter command in the admin database.

호환성

이 명령은 다음 환경에서 호스팅되는 배포에서 사용할 수 있습니다.

MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

중요

This command has limited support in M0 and Flex clusters. For more information, see Unsupported Commands.

MongoDB Enterprise: MongoDB의 구독 기반 자체 관리 버전
MongoDB Community: MongoDB의 소스 사용 가능 무료 자체 관리 버전

구문

명령은 다음과 같은 구문을 가집니다:

db.adminCommand(
   {
     getParameter: <value>,
     <parameter> : <value>,
     comment: <any>
   }
)

명령 필드

이 명령은 다음 필드를 사용합니다.

필드	유형	설명
`getParameter`	int, 문자열, 문서	다음 값을 지정합니다. `1` (또는 임의의 정수 값)을 입력하여 지정된 `<parameter>`의 값을 반환합니다. `''` to return values for all parameters available to `getParameter`, ignoring the `<parameter>` field. `{ showDetails: true }` 를 사용하여 다음이 포함된 문서를 반환: `value`, `<parameter>`가 다음으로 설정된 값 `settableAtRuntime`, 런타임 시 `<parameter>` 설정 가능 여부 `settableAtStartup`, 시작 시 `<parameter>`를 설정할 수 있는지 여부 `{ showDetails: true, allParameters: true }` to return a document containing showDetails fields for all* parameters. `{ allParameters: true }` 모든 매개변수가 포함된 문서 를 반환합니다. `{ allParameters: true, setAt: "startup" }` 스타트업 설정하다 수 있는 모든 매개변수가 포함된 문서 를 반환합니다. 버전 8.0에 추가 되었습니다. `{ allParameters: true, setAt: "runtime" }` 런타임에 설정하다 수 있는 모든 매개변수가 포함된 문서 를 반환합니다. 버전 8.0에 추가 되었습니다.
`<parameter>`	문자열	검색할 매개변수의 문자열 이름입니다. `<value>` 값은 출력에 영향을 주지 않습니다.
`comment`	any	선택 사항. 이 명령에 첨부할 사용자 제공 코멘트입니다. 설정되면 이 설명은 다음 위치에서 이 명령의 레코드와 함께 표시됩니다. mongod 로그 메시지( `attr.command.cursor.comment` 필드). 데이터베이스 프로파일러 출력의 `command.comment` 필드에 있습니다. `currentOp`{`command.comment` 5} 필드에 출력을 입력합니다. 댓글은 유효한 모든 BSON types (문자열, 정수, 객체, 배열 등)이 될 수 있습니다.

행동

getParameter runs on the admin database only, and returns an error if run on any other database.

<parameter>에 사용할 수 있는 값은 사용 중인 버전 및 스토리지 엔진에 따라 달라질 수 있습니다. 사용 가능한 매개변수 목록의 예는 모든 매개변수 조회를 참조하세요.

예시

Retrieve Single Parameter

The following operation runs getParameter on the admin database using a value of saslHostName to retrieve the value for that parameter:

db.adminCommand( { getParameter : 1, "saslHostName" : 1 } )

이 명령은 다음 출력을 반환합니다.

참고

출력은 MongoDB 인스턴스의 버전 및 특정 구성에 따라 달라질 수 있습니다.

{ "saslHostName" : "www.example.net:27018", "ok" : 1 }

Retrieve All Parameters

The following operation runs getParameter with a value of '*' to retrieve all parameters:

db.adminCommand( { getParameter : '*' } )

참고

출력은 MongoDB의 버전과 실행 중인 MongoDB 인스턴스의 특정 구성에 따라 달라질 수 있습니다.

팁

setParameter 에서 이러한 매개변수에 대해 자세히 알아보세요.

단일 매개변수에 대한 세부 정보 보고

The following example runs getParameter with {showDetails: true} to report details on saslHostName.

db.adminCommand( { getParameter : { showDetails: true }, "saslHostName" : 1 } )

출력 예시:

{
  saslHostName: {
    value: '<hostname>',
    settableAtRuntime: false,
    settableAtStartup: true
  },
  ok: 1
}

참고

출력은 MongoDB 인스턴스의 버전 및 특정 구성에 따라 달라질 수 있습니다.

모든 매개변수에 대한 세부 정보 보고

The following example runs getParameter with {showDetails: true, allParameters: true} to report details on all parameters.

db.adminCommand( { getParameter : { showDetails: true, allParameters: true } } )

Retrieve All Startup Parameters

버전 8.0에 추가 되었습니다.

The following example runs the getParameter command to retrieve all startup parameters:

db.adminCommand( {
   getParameters: {
      allParameters: true,
      setAt: "startup"
   }
} )

Retrieve All Runtime Parameters

버전 8.0에 추가 되었습니다.

The following example runs the getParameter command to retrieve all runtime parameters:

db.adminCommand( {
   getParameters: {
      allParameters: true,
      setAt: "runtime"
   }
} )

돌아가기

getDefaultRWConcern

killCursors