| PostgreSQL 8.3.3문서 | ||||
|---|---|---|---|---|
| Prev | Fast Backward | Fast Forward | Next | |
psql는 PostgreSQL의 터미널형 프론트엔드입니다. 대화적으로 쿼리를 입력해 그것을PostgreSQL에 대해서 발행해 결과를 확인할 수가 있습니다. 또, 파일로부터 입력을 읽어들이는 일도 가능합니다. 게다가 스크립트의 기술을 간편화하거나 여러가지 태스크를 자동화하거나 메타명령과 쉘을 닮은 각종의 기능을 갖추고 있습니다.
읽어들인 모든 행을 표준 출력에 표시합니다. 이것은 대화식 모드보다 스크립트 처리 시에 유용합니다. ECHO변수를all로 설정하는 것과 같은 의미를 가집니다.
정렬없는 출력 모드로 전환합니다 (기본값의 출력 모드는 정렬되어 집니다).
psql는 command 라고 하는 1개의 명령 캐릭터 라인을 실행해 종료하도록 지시합니다. 이 명령은 셸 스크립트내에서 유용합니다.
command 는 서버로 완전 해석 가능한 (즉,psql특유의 기능은 포함하지 않는다) 명령 캐릭터 라인 혹은 싱글 backslash 명령이 필요가 있습니다. 이 때문에 이 옵션에서는 SQL와 psql메타명령를 혼재시킬 수 없습니다. 이것들을 동시에 사용하려면 echo '\x \\ SELECT * FROM foo;' | psql와 같이 파이프를 사용해 캐릭터 라인을psql에 건네줍니다(\\는 메타명령의 단락 문자입니다. ).
명령 캐릭터 라인이 복수의 SQL 명령을 포함한다면 트랜잭션(transaction)를 복수로 나누는 BEGIN/COMMIT명령이 명시적으로 캐릭터 라인 내에 포함되지 않는 이상 그러한 명령은 1개의 트랜잭션(transaction)로 처리됩니다. 이것은 같은 캐릭터 라인을 psql의 표준 입력으로서 건네주었을 경우의 동작과는 다릅니다.
접속하는 데이터베이스의 이름을 지정합니다. 명령 라인에 최초의 옵션없는 인수로서 dbname 를 지정하는 것과 같은 효력을 가집니다.
서버에 보내진 명령을 표준 출력에도 보내 모든 SQL명령을 복사합니다. ECHO변수를 queries로 설정하는 것과 같은 효력을 가집니다.
\d나 그 외의 backslash 명령에 의해 생성되는 실제의 문의를 표시합니다. 이것을 사용해 psql의 내부 동작을 조사할 수가 있습니다. psql내부로부터ECHO_HIDDEN변수를 설정하는 것과 같은 효력을 가집니다.
대화식에 명령을 읽어내는 것이 아니라, filename 파일을 명령의 소스로서 사용합니다. 이 파일의 처리되어진 후,psql는 종료합니다. 이것은 \i내부 명령과 거의 같은 효력을 가집니다.
filename 에-(하이픈)를 지정하면 표준 입력으로부터 읽어내집니다.
이 옵션을 사용하는 것은 psql < filename 라고 입력하는 것은 미묘하게 동작이 다릅니다. 일반적으로는 양자 모두 기대 그대로의 동작을 실시하지만, -f를 사용했을 경우는 에러 메세지에 행 번호를 붙이는 등의 기능이 유효하게 됩니다. 또, 이 옵션을 사용했을 경우, 시작시의 오버헤드가 감소할 가능성이 약간 있습니다. 한편, 쉘의 입력 리디렉션을 사용하는 방법에서는 (이론적으로는) 모두 수작업으로 입력했을 경우의 출력과 완전히 동일한 출력이 되는 것이 보증됩니다.
separator 를 정렬을 실시하지 않는 출력에 대한 필드 단락 문자로서 사용합니다. \pset fieldsep혹은 \f와 같은 효력을 가집니다.
서버를 실행하고 있는 머신의 호스트명을 지정합니다. 이 값이 slash로부터 시작되는 경우, Unix 도메인 소켓용의 디렉토리로서 사용됩니다.
HTML표 출력을 유효하게 합니다. \pset format html혹은 \H명령과 같은 효력을 가집니다.
이용 가능한 모든 데이터베이스를 일람하고 종료합니다. 이 다른 접속에 관련하지 않는 옵션은 무시됩니다. \list내부 명령과 비슷한 효력을 가집니다.
모든 쿼리의 출력을 filename 파일에 쓰여집니다. 또한 보통 출력물 목적지에도 쓰여집니다.
모든 쿼리의 출력을 filename 파일에 기입합니다. 이것은 \o명령과 같은 효력을 가집니다.
서버가 접속 감시를 실시하고 있는 TCP 포트 또는 로컬 Unix 도메인 소켓 파일의 확장자(extension)를 지정합니다. PGPORT 환경 변수의 값 또는 환경 변수가 설정되어 있지 않은 경우는 컴파일시로 지정한 값(통상은 5432)이 기본값이 됩니다.
\pset형식에 의한 표시 옵션을 명령 라인으로부터 지정할 수가 있습니다. 여기에서는 공백은 아니고 등호를 사용해 이름과 값을 단락짓고 있는 것에 주의해 주세요. 즉, 출력 형식을 LaTeX로 설정하는 경우, -P format=latex라고 입력합니다.
psql가 메세지 출력없이 처리를 실시하도록 지시합니다. 기본값에서는 웰컴(welcome) 메세지와 각종의 출력 정보가 표시되지만, 이 옵션을 사용했을 경우, 이러한 메세지가 표시되지 않습니다. -c옵션과 함께 사용하면 편리합니다. psql내에서 QUIET변수를 설정했을 경우도 같은 효력을 얻을 수 있습니다.
separator 를 정렬을 실시하지 않는 출력에 있어서의 레코드 단락 문자로서 사용합니다. 이것은 \pset recordsep명령과 같습니다.
싱글스텝모드로 실행합니다. 이것은 각 명령이 서버에 송신되기 전에 사용자에 프롬프트 되는 것을 의미합니다. 디버그 스크립트를 실시할 때에 사용해 주세요.
싱글행 모드로 실행합니다. 이 모드에서는 세미콜론과 같이 개행도 SQL 명령의 종단으로서 다루어집니다.
Note: 이 모드는 아무래도 이러한 방식을 강요하는 사용자에게 제공될 것입니다. 무리하게 사용할 필요는 없습니다. 특히, 실행을 위해 행에SQL와 메타명령를 혼재시키는 경우, 경험이 부족한 사용자에게 있어 항상 명확히 되지 않을 수도 있습니다.
렬명과 결과의 행수 footer등의 표시를 무효로 합니다. 이것은 \t명령과 같은 효력을 가집니다.
HTML의 table태그로 사용되는 옵션을 지정할 수 있습니다.
자세한 것은 \pset를 참조해 주세요.
psql 데이터베이스에 접속하기 전에 사용자 이름과 패스워드에 대한 프롬프트를 띄웁니다.
이 옵션은 개념적인 결합으로 비난받을 수 있습니다. (그 서버가 실제로 두가지 다른 것을 요구되어지기 때문에 기본 사용자가 아닌 이름과 패스워드의 촉진되어집니다. ) -U와 -W 옵션을 장려합니다.
기본의 사용자가 아니고 username 사용자로서 데이터베이스에 접속합니다 (지정한 사용자가 데이터베이스에 접속하는 권한을 가지고 있어야 합니다).
\set내부 명령과 같이 변수의 대입을 실시합니다. 값이 있는 경우, 명령에서 이름과 값을 등호(=)로 이름과 값을 분리해야만 합니다. 등호를 지정하지 않으면 변수가 미설정 상태가 됩니다. 값없이 변수를 설정하려면 값을 지정하지 않고 등호만 사용해 주세요. 이러한 대입은 시작시의 매우 빠른 단계에서 행해집니다. 그 때문에 내부에서 사용하기 위해서 예약되고 있는 변수는 다음에 덧쓰기 될 가능성이 있습니다.
psql의 버젼을 표시하고 종료합니다.
데이터베이스에 접속하기 전에 psql는 강제적으로 패스워드 입력을 재촉합니다.
psql는 서버가 패스워드의 인증을 요구할 때 언제든지 자동적으로 프롬프트를 띄어야 합니다. 그러나 패스워트 요구 감지는 완전히 믿을 만 하지 않습니다. 그래서 이 옵션은 강제적으로 패스워드 입력을 재촉합니다. 만약 프롬프트에 패스워드가 없다면 발행되어야 하고 그 서버 요구 패스워드 인증과 연결은 실패 됩니다.
이 옵션은 세션 전체, 메타명령\connect와 데이터베이스의 접속의 변경조차 설정할 것입니다.
확장 테이블 형식 모드를 유효하게 합니다. 이것은 \x명령과 같습니다.
시작 파일(psqlrc파일 혹은 사용자의~/. psqlrc파일)을 읽어들이지 않습니다.
-f옵션을 사용해 psql가 스크립트를 실행할 때, 이 옵션을 더하면 스크립트를BEGIN/COMMIT로 둘러싸, 단일 트랜잭션(transaction)내에서 스크립트를 실행합니다. 이것에 의해 확실히 모든 명령이 완전하게 성공하는지, 변경이 전혀 행해지지 않는가의 어느 쪽인가에 됩니다.
스크립트 내부에서BEGIN, COMMIT, ROLLBACK를 사용하고 있는 경우, 이 옵션은 상정한 효과를 가져오지 않습니다. 또, 스크립트가 트랜잭션(transaction) 블록 내부에서 실행할 수가 없는 명령이 포함되어 있는 경우, 이 옵션을 지정하는 것은 그 명령은 실패(그리고 트랜잭션(transaction) 전체)합니다.
psql의 명령 라인 인수에 관한 도움을 표시하고 종료합니다.
psql는 정상적으로 종료했을 때에는 0을, psql에 있어 치명적인 에러(메모리 부족이나 파일이 발견되지 않는 등)가 발생했을 때에는 1을, 세션이 대화식이 아닌 상태로 서버와의 접속이 불완전하게 되었을 때에는 2를ON_ERROR_STOP변수가 설정되어 있는 상태로 스크립트로 에러가 발생했을 때에는 3을 쉘에 돌려줍니다.
psql는 PostgreSQL의 정식적 클라이언트 어플리케이션입니다. 데이터베이스에 접속하기 위해 접속하는 데이터 베이스명, 호스트명, 서버의 포트 번호, 접속할 때에 사용하는 사용자명을 알아야 합니다. psql는 그것들을 매개변수를 통해 명령 라인 옵션으로 지정할 수가 있습니다. 접속하는 데이터베이스명은 -d, 호스트명은 -h, 서버의 포트 번호는 -p, 접속하는 유저명은 -U를 사용해 각각 지정합니다. 옵션에 속하지 않는 인수가 있는 경우, 그것은 데이터 베이스명(데이터 베이스명이 주어지고 있는 경우에는 사용자명)으로 간주해집니다. 이러한 옵션은 모두 지정되는 것이 요구되어지지 않습니다. 지정되어 있지 않을 때는 기본값이 사용됩니다. 호스트명을 생략 했을 경우, psql는 Unix 도메인 소켓 경유로 로컬 호스트에게 있는 서버에 Unix 도메인 소켓을 가지지 않는 머신에서는 localhost에의 TCP/IP경유로 접속합니다. 기본값의 포트 번호는 컴파일시로 설정됩니다. 데이터베이스 서버는 같은 기본값을 사용하므로 대부분의 경우 포트는 지정할 필요는 없습니다. 기본값의 사용자 이름과 데이터베이스명은 Unix의 유저명입니다. 임의의 사용자명으로 모든 데이터베이스에 접속할 수 있는 것은 아닙니다. 데이터베이스 관리자는 접속 권한을 사용자에게 알려주어야 합니다.
기본값을 전혀 적용할 수 없을 때는 입력의 수고를 생략하기 위해서 환경 변수 PGDATABASE, PGHOST, PGPORT, PGUSER에 적당한 값을 설정할 수도 있습니다. (이 추가적인 환경 변수에 대해서는 Section 29.12을 참조해 주세요. ) 또한 ~/. pgpass파일을 사용하면 정상적인 패스워드의 입력을 막을 수가 있어 편리합니다. 자세한 것은 Section 29.13을 참조해 주세요.
어떠한 원인(권한이 불충불하거나 지정한 호스트로 서버가 가동하고 있지 않는 등)으로 접속을 할 수 없었던 경우는 psql는 에러 메세지를 표시하고 종료합니다.
통상의 조작에 대해 psql는 psql가 현재 접속하고 있는 데이터베이스명의 뒤에=>의 캐릭터 라인이 붙은 프롬프트를 표시합니다. 이하에 예를 나타냅니다.
$ psql testdb
Welcome to psql 8.3.3, the PostgreSQL interactive terminal.
Type: \copyright for distribution terms
\h for help with SQL commands
\? for help with psql commands
\g or terminate with semicolon to execute query
\q to quit
testdb=>
프롬프트에 대해 사용자는 SQL명령을 입력할 수가 있습니다. 보통 입력된 행은 명령문의 종료를 의미하는 세미콜론에 다다른 시점에 서버로 송신됩니다. 라인의 종료는 명령의 종료라고 보지 않습니다. 따라서 명확히 하기 위해서 명령은 복수의 행에 걸쳐서 기술할 수가 있습니다. 명령이 송신되고 문제없이 실행되면 화면에 명령의 결과가 표시됩니다.
또, 명령이 실행될 때 언제든지 psql는 LISTEN 과 NOTIFY 에 의해 생성된 비동기 통지 이벤트를 검사합니다.
psql내에서 입력된 명령 가운데 backslash로 시작되어 인용부호로 둘러싸이지 않은 것은 psql 자신이 실행하는 psql의 메타 명령으로 다루어집니다. 이러한 명령을 사용하면 데이터베이스를 관리하거나 스크립트를 작성할 때 psql가 보다 편리하게 됩니다. 메타 명령는 일반적으로 slash 명령, 또는 backslash 명령으로 불립니다.
psql명령은 backslash, 명령 본체, 인수에 연결한 형식이 되어 있습니다. 인수와 명령 동사의 사이는 공백 문자에 의해 분할되고 있습니다.
인수에 공백을 포함하는 경우는 단일 인용부호로 둘러쌉니다. 단일 인용부호를 인수에 포함하는 경우에는 그 단일 인용부호를 2개의 단일 인용부호를 사용해 주세요. 단일 인용부호로 둘러싸진 문자는 C언어와 같은 치환의 대상이 됩니다. 이러한 문자에는 \n(개행), \t(탭), \ digits (8 진수), \x digits (16 진수)가 있습니다.
인용부호로 둘러싸이지 않고 한편 콜론(:)으로 시작되는 인수는 psql변수로서 다루어집니다. 이 때는 변수의 값이 인수가 됩니다.
역인용부호(`)로 둘러싸인 인수는 명령 라인으로서 인식되어 쉘에게 건네집니다. 그리고 명령의 결과(개행은 삭제됩니다)가 인수의 값으로 간주해집니다. 역인용부호에 대해서도 상기의 escape sequence가 해당합니다.
몇몇 명령에는 인수로서SQL의(테이블명 등) 식별자를 취하는 것이 있습니다. 이러한 인수는 다음과 같은 SQL의 구문 규칙에 따릅니다. 인용부호를 수반하지 않는 문자는 강제적으로 소문자가 됩니다. 그러나, 이중 인용부호(")로 둘러싸이면 대문자 소문자 변환을 하지 않고 공백 문자를 식별자내에 포함할 수가 있습니다. 게다가 이중 인용 부호 내에서는 연속하는 2개의 이중 인용부호는 1개의 이중 인용부호로 간주해집니다. 예를 들면FOO"BAR"BAZ는 fooBARbaz라고 해석되어"A weird"" name"는 A weird" name가 됩니다.
인수의 해석은 인용부호로 둘러싸여 있지 않은 것도 1개의 backslash가 발견되면 멈춥니다. 이것은 새로운 메타명령의 시작이라고 인식됩니다. \\(2개 backslash)(이)라고 하는 특별한 스퀸스는 인수의 마지막에 체크하고 SQL명령이 남아 있는 경우는 그 해석을 계속합니다. 이와 같이 SQL명령과 psql명령은 1개의 행에 자유롭게 혼합해 기술할 수가 있습니다. 그러나, 모든 경우에 대해 메타명령의 인수는 행을 넘을 수 없습니다.
메타명령로서 이하의 것이 정의되고 있습니다.
현재의 테이블의 출력 형식이 정렬이 되어있지 않으면 정렬이 되도록 바꾸고 만약 정리가 되어있으면 그것을 정렬이 되어있지 않은 것으로 설정합니다. 이 명령은 후방 호환성을 보관 유지하기 위해서 있습니다. 보다 일반적인 해결책은 \pset를 참조해 주세요.
현재의 작업 디렉토리를 directory 로 변경합니다. 인수가 없는 경우는 현재의 사용자의 홈 디렉토리로 변경합니다.
Tip: 현재의 작업 디렉토리를 표시하려면 \! pwd를 사용해 주세요.
쿼리 또는 테이블의 설정 해제의 결과로 표시되는 테이블의 제목을 설정합니다. 이 명령은 \pset title title 와 같은 효력을 가집니다 (이 명령의 이름은 "caption"에 유래합니다. 이전에는 HTML의 테이블의 표제(caption)를 설정하기 위해 사용되고 있습니다).
PostgreSQL서버에의 새로운 접속을 확립합니다. 새로운 접속에 성공했을 경우, 이전의 접속은 닫힙니다. dbname , username , host , port 중 한쪽이 생략되거나 -지정되었을 경우, 대응하는 매개변수의 값은 지금까지의 접속의 값이 사용됩니다. 지금까지 접속되어 있지 않은 경우는 그 매개변수의 값에는 libpq의 기본값이 사용됩니다.
접속의 시행(잘못된 사용자명이나 액세스 거부 등)이 실패했을 경우, psql가 대화식 모드인 경우에 한해서 지금까지의 접속이 보관 유지됩니다. 비대화식 스크립트를 실행하고 있는 경우는 처리는 에러가 되어, 즉석에서 정지합니다. 이 실행의 차이는 대화 모드에서는 입력 미스에 대한 사용자의 간편성을 고려해 비대화 모드에서는 스크립트에 의해 잘못한 데이터베이스를 조작하는 것을 막기 위한 안전책을 고려한 결과 생기고 있습니다.
프론트엔드(클라이언트) 복사를 실시합니다. 이것은 COPY SQL명령을 실행하는 조작입니다. 그러나 그 서버의 지정 파일에 대한 읽기 또는 쓰기를 실시하는 것이 아니라, psql가 파일의 읽고 쓰기나 서버와 로컬 파일 시스템간의 데이터 송신을 실시합니다. 이 경우 파일에의 액세스 권한은 서버는 아니고 로컬 사용자의 것을 사용하므로 SQL의 슈퍼 유저 권한은 필요 없습니다.
이 명령의 구문은 COPY , SQL명령을 비슷합니다. 이 때문에 \copy 명령에는 특별한 해석 규칙이 적용되고 있는 것에 주의해 주세요. 특히, 변수의 치환 규칙이나 backslash 이스케이프는 적용되지 않습니다.
\copy ... from stdin | to stdout는 각각 명령의 입력과 출력을 바탕으로 읽고 쓰기를 실시합니다. 모든 행은 같은 시스템이 \.를 읽을 때 까지 거나 EOF에 다다를 때까지 계속해서 명령에 의해 발행된 같은 소스로 부터 계속해서 읽습니다. 출력물은 명령의 출력과 같은 곳에 보내집니다. psql의 표준 입력이나 표준 출력을 사용하려면 pstdin나 pstdout를 사용해 주세요. 이 옵션은 SQL 스크립트 파일의 내부에서 테이블에 데이터를 투입하는 경우에 편리합니다.
Tip: 이 조작은 SQL의 COPY명령 만큼 효율이 좋은 것은 아닙니다. 모든 데이터를 클라이언트/서버 접속을 통해서 교환해야 하기 때문입니다. 데이터량이 많을 때는 SQL명령을 사용하는 편이 좋을 것입니다.
PostgreSQL의 저작권 과 분배 조항을 표시합니다.
pattern 에 일치하는 각 릴레이션 (테이블, 뷰, 인덱스, 시퀀스)에 대해 모든 열, 열의 형태, 테이블 공간(기본값 이외를 사용하고 있는 경우), NOT NULL나 기본값등이 특별한 속성을 표시합니다. 그 관계가 뷰일 경우 뷰의 정의에 따라 관련지을 수 있고 있는 인덱스, 제약, 룰 및 트리거도 표시됩니다 ("패턴의 매칭"에 대해서는 후술 합니다).
\d+라고 하는 형식도 동일한 명령을 나타내지만 보다 많은 정보를 표시하는 것은 제외합니다. 이쪽에서는 테이블의 열에 관련지을 수 있었던 명령이나 테이블에 OID가 존재할지 어떨지도 표시됩니다.
Note: \d가 pattern 인수없이 사용되었을 경우는 \dtvs와 같은 의미가 되어 모든 테이블, 뷰, 시퀀스의 리스트에 표시됩니다. 이것은 단지 편의상 입니다.
이용할 수 있는 모든 집계 함수와 그 조작 대상이 되는 데이터형, 반환값의 데이터형의 일람을 표시합니다. pattern 가 지정되었을 경우 그 패턴에 이름이 일치하는 집계만이 표시됩니다.
이용 가능한 테이블 공간을 일람표 가리킵니다. pattern 가 지정되었을 경우, 그 패턴에 이름이 일치하는 테이블 공간만이 표시됩니다. 명령 이름에+가 부여되었을 경우, 각 오브젝트에 관련짓고 된 권한에 대해서도 표시합니다.
이용할 수 있는 모든 변환과 캐릭터 세트 encode 방식의 일람을 표시합니다. pattern 가 지정되었을 경우, 그 패턴에 이름이 일치하는 변환만이 표시됩니다.
이용할 수 있는 캐스트 타입의 리스트화 합니다.
pattern 에 일치하는 오브젝트의 설명을 표시하거나 인수가 지정되어 있지 않은 경우는 모든 가시적인 오브젝트의 설명을 표시합니다. 어느 쪽의 경우에서도 일람에 표시되는 것은 설명을 가지는 오브젝트만입니다 ("오브젝트"에는 집약, 함수, 연산자, 형태, 관계(테이블, 뷰, 인덱스, 시퀀스, 라지 오브젝트)이 포함됩니다). 다음에 예를 나타냅니다.
=> \dd version
Object descriptions
Schema | Name | Object | Description
------------+---------+----------+---------------------------
pg_catalog | version | function | PostgreSQL version string
(1 row)
오브젝트의 설명은 COMMENT SQL명령을 사용해작성할 수가 있습니다.
사용 가능한 도메인을 모두 표시합니다. 만약 pattern 가 지정되고 있는 경우는 일치하는 명령만이 표시됩니다.
이용할 수 있는 함수와 그 인수와 반환 값의 형태를 목록에 표시 합니다. pattern 가 지정되고 있는 경우는 그 패턴에 이름이 일치하는 함수만이 표시됩니다. \df+라고 하는 형식에서 사용되었을 경우, 각 함수의 정보나 포함되는 언어와 설명을 포함한 부가적 정보도 표시됩니다.
Note: To look up functions taking argument or returning values of a specific type, use your pager's search capability to scroll through the \df output. --> 취하는 인수의 함수나 특정의 형태 값을 리던해 주는 함수를 검색하는 경우 \df을 통해 스크롤 하기 위해 페이지의 검색 기능을 사용합니다.
To reduce clutter, \df does not show data type I/O functions. This is implemented by ignoring functions that accept or return type cstring. --> 불필요한 정보를 줄이기 위해\df는 데이터형 I/O함수를 표시하지 않습니다. 이것은 수락하거나 반환되는 타입 cstring의 무시하는 함수에 의해 실행되어 집니다.
모든 데이터베이스 롤을 목록을 표시합니다. pattern 가 지정되고 있는 경우는 그 패턴에 이름이 일치하는 롤만이 표시됩니다. (이 명령은 지금 실제로 \du와 같게 되었습니다. )
이것들은 실제의 명령명이 아닙니다. i, s, t, v, S라고 하는 문자는 각각 인덱스, 시퀀스, 테이블, 뷰, 시스템 테이블을 의미합니다. 이러한 문자중 임의의 것을 임의의 차례로 지정하면 일치하는 모든 오브젝트의 목록을 표시할 수가 있습니다. 문자S를 지정하면 시스템 오브젝트만이 표시됩니다. S를 지정하지 않으면 시스템 오브젝트 이외의 오브젝트만이 표시됩니다. 명령명의 뒤에+를 덧붙인다면 각 오브젝트가 그와 관련된 설명과 함께 목록이 표시됩니다.
pattern 를 지정하면 패턴에 이름이 일치하는 오브젝트만이 표시됩니다.
\lo_list의 별명으로 라지 오브젝트의 목록을 표시합니다.
이용할 수 있는 모든 schema(이름 공간)의 목록을 표시합니다. pattern (정규 표현)를 지정하면 패턴에 이름이 일치하는 schema만이 표시됩니다. 로컬이 아닌 일시적인 schema는 표시되지 않습니다. 명령명의 뒤에+를 덧붙인다면 각 오브젝트가 그와 관련된 설명과 함께 목록이 표시됩니다.
이용할 수 있는 연산자와 그 연산 항목과 반환값을 일람표 가리킵니다. pattern 를 지정하면 패턴에 이름이 일치하는 연산자만이 표시됩니다.
사용 가능한 모든 테이블, 뷰, 시퀀스를 관련지을 수 있고 접근 권한과 함께 리스트를 생산합니다. pattern 를 지정하면 패턴에 이름이 일치하는 테이블, 뷰, 시퀀스만이 표시됩니다.
모든 데이터 타입 이나 pattern 와 일치하는 형태의 목록을 표시합니다. \dT+라고 하는 형식의 명령에서는 보충 정보도 표시됩니다.
모든 데이터베이스 롤이나 pattern 를 일치하는 것만을 표시합니다.
filename 가 지정되었을 경우, 이 파일이 편집됩니다. 에디터를 종료한 후, 그 컨텐츠는 쿼리의 버퍼에 복사됩니다. 인수가 없는 경우, 현재의 쿼리의 버퍼가 일시적인 파일에 복사되어 똑같이 편집됩니다.
새로운 쿼리의 버퍼는 통상의psql의 규칙에 따라, 재해석됩니다. (이 때문에 이 방법에서는 " 스크립트"를 작성할 수 없습니다. 이 목적을 위해서\i를 사용해 주세요). 이것은 또, 쿼리문의 종단이 세미콜론인(혹은 문의가 세미콜론을 포함한다) 경우, 곧바로 실행되는 것을 의미하고 있습니다. 세미콜론이 없는 경우는 단지 문의 버퍼내에 보관 유지될 뿐입니다.
Tip: psql는 환경 변수 PSQL_EDITOR, EDITOR, VISUAL를 이 차례로 검색해 사용하는 에디터를 결정합니다. 이러한 환경 변수가 모두가 미설정인 경우는 Unix 시스템에서는 vi가 Windows 시스템에서는 notepad.exe가 실행됩니다.
인수를 공백에서 단락지어 표준 출력에 출력해 개행합니다. 스크립트의 출력물에 정보를 뿌리기 위해 유용합니다. 사용 예를 다음에 나타냅니다.
=> \echo `date` Tue Oct 26 21:40:57 CEST 1999
최초의 인수가 인용부호로 둘러싸이지 않았다-n인 경우 마지막 개행은 출력되지 않습니다.
Tip: \o명령을 사용해 쿼리문의 출력처를 변경했을 경우, 이 명령은 아니고 \qecho를 사용하는 것이 좋을 것입니다.
클라이언트측의 캐릭터 세트 encode 방식을 설정합니다. 인수를 지정하지 않는 경우, 이 명령은 현재의 encode 방식을 표시합니다.
정렬되지 않은 쿼리의 출력물로 필드를 설정합니다. 기본값은 수직선("|")입니다. 일반적인 출력 옵션의 설정 방법에 대해서는 \pset를 참조해 주세요.
현재의 쿼리의 입력 버퍼를 서버에 보냅니다. 옵션을 지정하면 쿼리의 출력을 filename 에 저장하거나 그 출력을 다른 Unix 쉘에 건네주어 command 를 실행할 수도 있습니다. \g만을 지정했을 경우는 세미콜론과 실질적으로 같습니다. \g에 인수를 지정했을 경우는 \o명령의 "one-shot"대체 수단으로서 사용할 수 있습니다.
지정한SQL명령의 구문에 관한 도움를 표시합니다. command 가 지정되어 있지 않은 경우는 psql는 구문 헬프가 존재하는 모든 명령의 목록을 표시합니다. command 를 asterisk(*)로 하면 모든SQL명령의 구문 헬프가 표시됩니다.
Note: 입력을 간단하게 하기 위해 복수의 단어로부터 되는 명령을 인용부호로 둘러쌀 필요는 없습니다. \help alter table라고 입력하는 것만으로 충분합니다.
HTML쿼리의 출력 형식을 유효하게 합니다. HTML형식이 유효하게 되어 있는 경우는 기본값의 정렬된 텍스트 형식에 되돌립니다. 이 명령은 호환성과 간편성을 위해서 존재합니다. 다른 출력 옵션에 대해서는 \pset를 참조해 주세요.
filename 파일로부터 입력을 읽어내, 키보드로부터 입력되었을 경우와 같이 실행합니다.
Note: 만약 화면에 읽어내진 행을 화면에서 보길 원한다면 ECHO변수를 all로 설정되는 변수를 설정해야 합니다.
서버상의 모든 데이터베이스의 이름, 소유자, 캐릭터 세트 encode 방식의 목록을 표시합니다. 이 명령에+를 붙이면 상기에 가세해 데이터베이스의 설명도 표시합니다.
데이터베이스로부터
loid
라고 하는 OID를 가지는 라지 오브젝트를 읽어내,
filename
에 써냅니다.
이것은 lo_export 서버 함수와는 미묘하게 다릅니다.
lo_export함수는 데이터베이스 서버를 실행하고 있는 사용자 권한과 서버상의 파일 시스템에 대해서 동작합니다.
Tip: 라지 오브젝트의OID를 확인하려면 \lo_list를 사용해 주세요.
파일을PostgreSQL의 라지 오브젝트에 저장합니다. 선택적으로 그 오브젝트로 지정한 명령을 관련지을 수가 있습니다. 아래와 같이 예를 나타냅니다.
foo=> \lo_import '/home/peter/pictures/photo.xcf' 'a picture of me' lo_import 152801
위의 응답은 라지 오브젝트가 만약 오브젝트와 다시 접근을 원한다면 기억해야하는 오브젝트 ID 152801으로서 받아들일 수 있던 것을 나타냅니다. 이러한 이유로 항상 각 오브젝트와 함께 모든 오브젝트에 사람이 읽기 쉬운 명령에 관련짓는 것이 추천되어 집니다. \lo_list명령과 함께 보여질 수 있습니다.
서버의 사용자와 파일 보다는 로컬 파일 시스템에서 로컬 사용자로 동작하기 때문에 이 명령은 서버측의lo_import로 부터 미묘한 차이가 있다는 것에 주의하세요.
system.
현재 데이터베이스에 보존되고 있는 모든PostgreSQL라지 오브젝트의 모든 목록을 그들에게 제공되어지는 명령에 따라 보여줍니다.
데이터베이스로 부터 loid 라고 하는 OID가 가리키는 라지 오브젝트를 데이터베이스를 삭제합니다.
Tip: 라지 오브젝트의OID를 확인하려면, \lo_list를 사용해 주세요.
이후의 쿼리의 결과를 filename 로 지정된 파일에 보존하거나 또는 다른 Unix 쉘에 건네주어 command 를 실행합니다. 만약 인수가 지정되어 있지 않은 경우, 쿼리의 출력은 표준 출력에 재설정 됩니다.
"Query results"에는 모든 테이블, 명령의 응답, 데이터베이스 서버로부터의 주의 메시지 뿐만 아니라, 데이터베이스에 쿼리를 실시하는(\d와 같은) 각종 backslash 명령의 출력이 포함됩니다. 다만, 에러 메세지는 포함되지 않습니다.
Tip: 쿼리 결과의 사이에 텍스트를 뿌리기 위해 \qecho를 사용해 주세요.
현재의 쿼리문의 버퍼를 표준 출력에 써냅니다.
지정한 사용자(기본값에 의해는 현재의 사용자)의 패스워드를 변경합니다. 이 명령은 새로운 패스워드, 암호화에 대해 그것을 프롬프트 합니다. ALTER ROLE명령으로서 그 서버에 송신합니다. 이것은 그 새로운 패스워드는 평문, 명령 이력, 서버 로그 또는 그밖에 어느 곳에서도 나타나지 않는 것을 확실합니다.
이 명령은 테이블의 쿼리 결과의 출력물에 영향을 주는 옵션을 설정합니다. parameter 에는 어느 옵션을 설정하는지를 기술합니다. value 의 의미는 이 parameter 에 의존합니다.
다음은 조정할 수 있는 표시 옵션입니다.
출력 형식을 unaligned, aligned, html, latex, troff-ms의 어느 쪽인가에 설정합니다. 유일무의한 생략은 허락되어 집니다. (그것은 한 문자로 충분하다라는 것을 의미합니다.)
"Unaligned"는 라인에 현재 활성화된 필드 구분 기호로 구분하여 행의 모든 열을 씁니다. 이것은 다른 프로그램에서 읽을 수 있게 하려는 탭 단락이나 콤마 단락 등의 의도로 출력을 만들 수 있을 것입니다. "Aligned"모드는 인간이 읽기 쉽게, 아름답게 정형된 표준적인 텍스트 출력이 기본입니다. "HTML"와 "LaTeX"모드는 대응하는 마크업 언어의 문서에 포함할 수가 있는 형식에서 테이블을 출력합니다. 그것은 완전한 문서가 아닙니다.(이것은 HTML에서 극적이지 않을 수도 있습니다. 그러나 LaTeX 완전한 문서의 wrapper를 가지고 있어야만 합니다.)
두번째의 인수는 숫자여야만 합니다. 일반적으로 이 숫자가 많아지면 표시하는 테이블이 가지는 경계선은 증가하지만, 구체적으로는 각각의 출력 형식에 의존하고 있습니다. HTML모드에서는 이 값은 직접border=...속성에 반영됩니다. 다른 형식의 경우는 0(경계선 없음), 1(안쪽의 경계선), 2(테이블범위)라고 하는 3개의 수치만 유효합니다.
일반 및 확장 포맷 사이에 움직입니다. 확장 형식을 활성화했을 때, 두 개의 열이 쿼리 결과에오른쪽에서 왼쪽에있는 열 이름과 데이터와 함께 표시됩니다. 만약 데이터를 표준 "horizontal"모드에서 화면에 맞지 않을 이 모드는 유용하게 사용됩니다.
확장 모드는 4개의 모든 형식에서 지원되고 있습니다.
두번째의 인수는 열이 null의 경우에 표시하는 캐릭터 라인입니다. 기본값에서는 아무것도 표시하지 않습니다. 그 때문에 자주 빈 캐릭터 라인과 잘못하는 일이 있습니다. 이러한 경우 \pset null '(null)'를 사용하는 편이 좋을 것입니다.
정렬없는 출력 모드로 사용되는 필드 단락 문자를 지정합니다. 이것에 의해 예를 들면 탭 단락이나 콤마 단락이라고 하는 타프로그램이 자주 사용하는 형식을 작성할 수가 있습니다. 탭을 필드 단락 문자로서 사용하려면 \pset fieldsep '\t'라고 입력합니다. 기본의 필드 단락 문자는 '|'(세로의 곧은 선)입니다.
기본의 footer (x rows)의 표시를 움직입니다.
로컬에서 알고있는 특징의 표시를 10진수의 왼쪽에 별도의 그룹으로 전환합니다. 그것도 또한 로켈에 알고있는 10진수로 작동시킵니다.
정렬없이 출력 모드로 사용되는 레코드(라인)의 단락 문자를 지정합니다. 그 기본값이 개행 문자입니다.
튜플과 전체 표시 사이에 이동합니다. 전체적인 표시는 열의 헤더, 제목 각종 footer와 같이 여분의 정보는 표시 될지도 모릅니다. 오직 튜플 모드에서 실제적으로 오직 테이블 데이터가 보여집니다.
향후 표시되는 모든 테이블용으로 테이블 제목을 설정합니다. 이것은 출력에 설명을 위한 태그를 붙이고 싶은 경우에 유용합니다. 인수가 없는 경우 제목은 설정되지 않습니다.
HTML table태그내에 기술하는 임의의 속성을 지정할 수 있습니다.
이것은 예를 들면cellpadding나bgcolor를 지정할 수가 있습니다.
border 속성은 이미\pset border에 의해 처리되고 있으므로
이 명령으로border를 지정할 필요는 없습니다.
쿼리와 psql헬프 출력의 pager의 사용을 제어합니다. PAGER환경 변수가 설정되어 있는 경우, 출력은 지정한 프로그램에 파이프로 건네받습니다. PAGER가 설정되어 있지 않은 경우는 플랫폼 의존의 기본값(more등)이 사용됩니다.
pager가 무효로 될 때, pager는 사용되지 않습니다. pager가 유효로 될 때, pager의 사용이 적절한 경우 즉, 출력물이 중료되거나와 화면에 맞지 않게 될 ? 사용되어 집니다. (psql는 pager의 사용할 때 판단은 완전하지는 않습니다). \pset pager는 pager의 유효/무효를 바꿉니다. 또 pager는 항상 사용되는 pagerd의 이유로 always로 설정되어질 수 있습니다.
예제 부분에 이러한 형식이 어떻게 보이는지를 나타낸 실례가 있습니다.
Tip: \pset에는 각종의 쇼트 컷 명령이 있습니다. \a, \C, \H, \t, \T, \x를 참조해 주세요.
Note: 인수없이 \pset를 호출했을 경우는 에러가 됩니다. 향후의 버젼에서는 이것이 모든 표시용 옵션의 현재 상태를 보여주는 것을 호출되게 될 수도 있습니다.
psql프로그램을 종료합니다.
이 명령은 다만 \o에 의한 설정과 같이 그 출력물이 쿼리 출력 채널에 써지는 것을 제외하고 \echo와 같습니다.
쿼리의 버퍼를 재설정(삭제) 합니다.
명령 라인의 이력의 표시 또는 filename 에의 저장합니다. filename 가 생략 되었을 경우, 이력은 표준 출력에 써내집니다. 만약 psql이 GNU Readline라이브러리를 사용하는 것으로 구성되어 있다면 이 옵션은 사용 가능합니다.
value , 또는 하나 이상의 값이 주어졌을 경우는 그것들을 연결하기 위해 name 내부 변수를 설정합니다. 두번째의 인수가 없는 경우, 변수가 값이 없는 것으로 설정됩니다. 변수를 설정하지 않으면, \unset명령을 사용해 주세요.
변수명은 문자, 숫자, 언더 스코아를 사용할 수가 있습니다. 자세한 것은 다음의 변수 을 참조해 주세요. 변수명은 대문자 소문자를 구별합니다.
필요하면 어떠한 것에서도 임의의 변수로 설정할 수 있지만, psql는 몇개의 변수를 특별히 취급하고 있습니다. 이것들에 대해서는 변수에 관한 섹션에 설명되어 있습니다.
Note: 이 명령은 SQL SET 명령과는 완전히 별개의 것입니다.
출력렬명 헤더와 행수footer의 표시를 바꿉니다. 이 명령은 \pset tuples_only와 같아 간편성을 위해서 준비되어 있습니다.
HTML표 형식 출력 모드의table태그 내부에 기술하는 속성을 지정할 수 있습니다.
이 명령은 \pset tableattr
table_options
와 같은 효력을 가집니다.
각 SQL명령문에 걸리는 시간(밀리 세컨드 단위)의 표시의 유무를 바꿉니다.
현재의 쿼리 버퍼를 filename 파일에 출력하거나 혹은 command Unix 명령에 파이프로 건네줍니다.
확장 테이블 형식 모드를 바꿉니다. 이 명령은 \pset expanded와 같은 효력을 가집니다.
사용 가능한 모든 테이블, 뷰, 시퀀스를 관련지을 수 있고 있는 액세스 권한과 함께 표시합니다. pattern 를 지정하면 패턴에 이름이 일치하는 테이블, 뷰, 시퀀스만이 표시됩니다.
GRANT 명령과 REVOKE 명령은 액세스권한의 설정에 의해 사용됩니다.
이것은 \dp("권한의 표시(display privileges)")의 별명입니다.
다른 쉘을 기동하는지 혹은 Unix의 command 명령을 실행합니다. 인수는 더 이상 해석되지 않고 그대로 쉘에게 건네집니다.
backslash("\") 명령에 관한 헬프 정보를 표시합니다.
각종 \d명령에서는 표시되는 오브젝트명을 지정하기 위해 pattern 매개변수를 수락합니다. 패턴이 정확하게 오브젝트명에 일치한다는 것이 가장 단순한 경우입니다. 패턴내의 문자는 SQL명과 같이 보통 소문자로 변환됩니다. 예를 들면\dt FOO는 foo라는 이름의 테이블을 표시합니다. SQL명과 같이 패턴을 이중 인용부호로 해야 한다면 소문자에의 변환을 그만둘 수 있습니다. 이중 인용부호 자체를 패턴내에 포함하지 않으면 안 되는 경우, 이중 인용부호로 캐릭터 라인 중에서 이중 인용부호를 이중으로 기재해 주세요. 반복하지만, 이것은 SQL의 인용부호 첨부 식별자의 규칙에 따른 것입니다. 예를 들면\dt "FOO""BAR"는 FOO"BAR라는 이름의 테이블을 표시합니다(foo"bar가 아닙니다). SQL명과 다른 점은 패턴의 일부를 이중 인용부호로 생기는 점입니다. 예를 들면\dt FOO"FOO"BAR는 fooFOObar라는 이름의 테이블을 표시합니다.
패턴 내부에서는 *은 어느 문자(0 문자를 포함한다) 시퀀스와 일치하고 ? (은)는 임의의 문자와 일치합니다. (이 기법은 Unix 쉘의 파일명 패턴과 닮아 있습니다. ) 예를 들면\dt int*는 int로부터 시작되는 이름을 가지는 모든 테이블을 표시합니다. 그러나, 이중 인용부호 중에서는 *이라고? (은)는 그 특별한 의미를 잃어, 문자 그 자체에 일치하게 됩니다.
닷(. )(을)를 포함한 패턴은 schema명에 오브젝트명이 계속되는 패턴으로서 해석됩니다. 예를 들면\dt foo*. *bar*는 foo로 시작되는 schema내의bar를 포함한 테이블을 모두 표시합니다. 닷이 없는 경우, 패턴은 현행의 schema 검색 패스내에서 가시적인 오브젝트에만 일치합니다. 반복합니다만, 이중 인용부호로 괄캐릭터 라인내의 닷은 특별한 의미를 잃어, 문자 그 자체에 일치하게 됩니다.
상급자는 문자 클래스에 예를 들면 임의의 수에 일치하는 [0-9]등의 정규 표현을 사용할 수가 있습니다. 위에서 설명한 바와 같이. 하지만 단락 문자가 되는 점,*은 정규 표현의. *기법이 되는 점,? 하지만. (이)가 되는 점,$이 그대로 다루어지는 점은 예외이지만, 모든 정규 표현의 특수 문자가Section 9.7.3의 규정 대로에 동작합니다. . (은)는 ? 라고 R *는 ( R +|)과 R ? (은)는 ( R |)과 기술하는 것으로 이러한 패턴 문자를 모의 할 수가 있습니다. $(을)를 정규 표현 문자로서 취급할 필요는 없습니다. 통상의 정규 표현의 해석과 달리, 패턴은 항상 이름 전체에 일치하기 때문에입니다. 그 패턴이 고정되길 바라지 않는 경우는 *을 선두나 말미에 기재해 주세요. 이중 인용부호의 안쪽에서는 정규 표현의 특수 문자는 그 의미를 잃어, 문자 그 자체에 일치하게 되는 점에 주의해 주세요. 또, 정규 표현의 특수 문자는 연산자명 패턴(즉\do의 인수)에서는 문자 그 자체에 일치합니다.
pattern 매개변수가 완전하게 생략 되고 있는 경우, \d명령은 현재의 schema 검색 패스내에서 가시적인 오브젝트를 모두 표시합니다. 이것은 *이라고 하는 패턴을 사용하는 것과 같습니다. 데이터베이스내의 모든 오브젝트를 표시하려면, *. *그렇다고 하는 패턴을 사용합니다.
psql는 일반적인 Unix 명령 쉘을 닮은 변수의 치환 기능을 제공합니다. 변수와는 이름과 값의 편성입니다. 값으로 해서 임의의 길이의 임의의 캐릭터 라인을 사용할 수 있습니다. 변수를 설정하려면, psql의\set메타명령를 이하와 같이 사용합니다.
testdb=> \set foo bar
이 예에서는 foo변수를bar라고 하는 값으로 설정해 있습니다. 변수의 내용을 꺼내려면, 이하와 같이 변수명의 전에 구두점을 붙여 임의의 slash 명령의 인수로서 사용합니다.
testdb=> \echo :foo bar
Note: \set의 인수는 다른 명령과 함께 같은 치환 규칙에 따릅니다. 이 때문에\set :foo 'something'와 같은 참조를 작성해Perl에 있어서의"소프트 링크"나 PHP 에 있어서의"가변 변수"에 해당되는 것을 얻을 수 있습니다. 그러나, 유감스럽지만(혹은 다행으로), 이러한 구성을 잘 사용하는 방법은 없습니다. 한편,\set bar :foo는 변수를 복사하는 것은 완전하게 유효한 방법입니다.
두번째의 인수를 지정하지 않고\set를 실행했을 경우, 값으로 해서 공문자열을 가지는 변수로서 설정됩니다. 변수를 미설정으로 하려면(또는 삭제) ,\unset명령을 사용해 주세요.
psql의 내부 변수명은 문자, 숫자, 언더 스코아로부터 구성됩니다. 차례나 길이에는 제한이 없습니다. 이러한 변수의 상당수는 psql에의해 특별 취급 되고 있습니다. 변수의 변화나 애플리케이션의 상태 표현에 의해 그들은 실행시 설정된 옵션의 설정이 변화 될 수 있습니다. 이러한 변수를 다른 목적으로 사용할 수도 있지만, 즉석에서 프로그램의 동작이 이상해질 가능성이 있기 때문에 추천 되지 않습니다. 관습상, 특별시 되는 변수는 모두 대문자(가능한한 숫자와 언더 스코아)로부터 됩니다. 장래적인 호환성을 최대한 고려하기 위해서 스스로 작성한 변수에는 이러한 변수명을 사용하지 말아 주세요. 이하에 특별히 취급되는 변수의 일람을 나타냅니다.
When on (the default), each SQL command is automatically 이 변수의 값이 on의 경우(자동 커밋 유효 모드：기본값), 각 SQL 명령의 실행이 성공하면 자동적으로 커밋됩니다. 커밋을 연기하려면, BEGIN혹은 SQL의START TRANSACTION명령을 입력할 필요가 있습니다. 값이off혹은 미설정의 경우(자동 커밋 무효 모드), 명시적으로COMMIT혹은 END를 발행할 때까지, SQL 명령은 커밋되지 않습니다. 자동 커밋 무효 모드에서는 트랜잭션(transaction) 블록 이외로 명령가 발행되면 그 명령을 실행하기 전에 자동적으로BEGIN명령가 발행됩니다 (다만, 그 명령 자체가BEGIN명령이나 그 외의 트랜잭션(transaction) 제어 명령인 경우, 트랜잭션(transaction) 블록내에서 실행할 수가 없는 명령(VACUUM등)인 경우는 제외합니다)
Note: 따라서 자동 커밋 무효 모드에서는 ABORT나ROLLBACK를 발행해 명시적으로 실패한 트랜잭션(transaction)를 포기해야 합니다. 또, 커밋하지 않고 세션을 종료했을 경우는 작업이 없어져 버릴수 있으니 주의해 주세요.
Note: PostgreSQL는 전통적으로 자동 커밋 유효 모드로 동작하고 있었지만, 자동 커밋 무효 모드가 보다 SQL의 사양에 가까운 것입니다. 자동 커밋 무효 모드는 시스템 전체에 대한psqlrc파일 혹은 개인용의. psqlrc파일로 설정하면 실현될 수 있습니다.
현재 접속하고 있는 데이터베이스명입니다. 이 변수는(시작 프로그램 포함) 데이터베이스에 접속할 때도 설정되지만, 이것을 미설정으로 할 수도 있습니다.
all를 설정했을 경우, 키보드 혹은 스크립트로부터의 취득된 모든 행은 해석/실행 전에 표준 출력에 써내집니다. 이 동작을 프로그램 시작시로 설정하려면, -a 스위치를 사용해 주세요. queries를 설정했을 경우, psql는 서버에 송신된 쿼리만을 표시합니다. 이것들을 바꾸는 옵션은 -e입니다.
이 변수가 설정되어 있는 경우, backslash 명령로 데이터베이스에 쿼린를 실시할 때, 최초로 그 쿼리가 표시됩니다. 이것에 의해PostgreSQL내부 동작에 대해 조사하거나 소유한 프로그램내에서 같은 함수 기능을 준비하거나 하는 것이 가능하게 됩니다 (이 동작을 프로그램 시작시에 선택하려면-E 스위치를 사용해 주세요). 이 변수를noexec라고 하는 값으로 설정했을 경우, 쿼리는 실제로 서버에 송신, 실행되지 않고 , 단지 표시되는 만큼 됩니다.
현재의 클라이언트측의 캐릭터 세트 encode 방식입니다.
이 변수가 0보다 큰 integer로 설정되어 있는 경우, SELECT쿼리의 결과는 표시하기 전에 모든 결과 모음의 행동 기본값 보다지정한 행수의 집합으로서 꺼내져 표시됩니다. 따라서 결과 세트의 크기 에 비례하는 형태로 메모리의 사용량이 한정됩니다. 이 기능을 유효로 하는 경우에 100에서 1000까지의 값이 자주 사용됩니다. 이 기능을 사용할 때 이미 일부의 행이 표시되고 있는 경우, 쿼리가 실패할 가능성이 있는 것에 주의해 주세요.
Tip: 임의의 출력 서식에서 이 기능을 사용할 수가 있지만, 기본값의aligned서식은 적합하지 않습니다. FETCH_COUNT행의 그룹 각각이 따로 따로 정형되어 버려, 행의 그룹에 의해 렬폭이 다르게 되기 때문에입니다. 다른 출력 서식은 적절히 동작합니다.
이 변수를ignorespace로 설정했을 경우, 공백 문자로부터 시작되는 행은 이력 리스트에는 들어가지 않습니다. ignoredups로 설정했을 경우, 지금까지의 이력에 있는 행은 이력 리스트에 들어가지 않습니다. ignoreboth로 설정했을 경우는 상기의 2개를 조합한 것이 됩니다. 이 변수를 설정하지 않는 경우, 또는 상기 이외의 값을 설정하는 경우는 대화 모드로 읽혀지는 모든 행이 이력 리스트에 보존됩니다.
Note: 이 기능은 Bash의 기능을 흉내낸 것입니다.
이력을 저장하기 위해서 사용되는 파일의 이름입니다. 기본값에서는는 ~/. psql_history입니다. 예를 들면~/. psqlrc로 이하를 기술하면psql는 데이터베이스마다 나누어 이력을 관리합니다.
\set HISTFILE ~/.psql_history- :DBNAME
Note: 이 기능은 Bash의 기능을 흉내낸 것입니다.
명령 이력에 보존하는 명령 수입니다. 기본값은 500입니다.
Note: 이 기능은 Bash의 기능을 흉내낸 것입니다.
접속중의 데이터 베이스 서버 호스트입니다. 이 변수는(시작프로그램 포함) 데이터베이스에 접속할 때도 설정되지만, 미설정으로 할 수도 있습니다.
이 변수를 설정 안 했다면 대화식 세션에EOF문자 (통상Control+D)가 송신되었을 때, psql가 종료됩니다. 수치를 설정하면 지정된 수만큼 송신된EOF문자를 무시하고 나서 종료합니다. 수치 이외를 설정했을 경우는 기본값의 10이 됩니다.
Note: 이 기능은 Bash의 기능을 흉내낸 것입니다.
INSERT나lo_insert명령에 의해 돌려주어진 마지막에 영향을 받은 OID의 값입니다. 이 변수는 다음의SQL명령의 결과가 표시될 때까지만 보증되고 있습니다.
on의 경우, 트랜잭션(transaction) 블록내인 문장이 에러가 되었을 때에 그 에러는 무시되어 트랜잭션(transaction)는 계속합니다. interactive의 경우, 대화식 세션내의 경우에게만 에러는 무시됩니다. 스크립트 파일을 읽어들이고 있는 경우는 무시되지 않습니다. off(기본값)의 경우, 트랜잭션(transaction) 블록내의 문장이 에러가 되면 트랜잭션(transaction) 전체를 중단(abort) 합니다. ON_ERROR_ROLLBACK가 on라고 하는 상태는 트랜잭션(transaction) 블록내에서 각 명령의 실행 직전에 암묵적인SAVEPOINT를 실시해 에러가 일어났을 때에 이 세이브 포인트에 롤백(rollback) 합니다.
기본값에서는 비대화식 스크립트에서SQL명령이나 내부 메타명령에 대해 에러가 발생했을 경우, 처리는 속행됩니다. 이것은 psql의 구래부터의 동작이지만, 바람직하지 않은 경우도 있습니다. 거기서 이 변수를 설정해 두면 에러 발생시에 처리중의 스크립트가 즉석에서 정지합니다. 스크립트가 다른 스크립트로부터 불리고 있었을 경우는 호출원의 스크립트도 이와 같이 정지합니다. 가장 외측의 스크립트가psql의 대화식 세션으로부터는 아니고 -f옵션을 사용해 불려 가고 있었을 경우, psql는 치명적 에러 조건(에러 코드 1)과 구별하기 위해서 에러 코드 3을 돌려줍니다.
접속중의 데이터 베이스 서버의 포트입니다. 이 변수는(시작프로그램 포함) 데이터베이스에 접속할 때도 설정되지만, 미설정으로 할 수도 있습니다.
이러한 변수는 psql가 발행하는 prompt의 외형을 지정합니다. 후술의 것 prompt 을 참조해 주세요.
이 변수는 -q명령 라인 옵션과 같은 효력을 가집니다. 대화식 모드에서는 그다지 도움이 되지 않습니다.
이 변수는 -S명령 라인 옵션과 같은 효력을 가집니다.
이 변수는 -s명령 라인 옵션과 같은 효력을 가집니다.
접속중의 데이터베이스 사용자입니다. 이 변수는(시작프로그램 포함) 데이터베이스에 접속할 때도 설정되지만, 미설정으로 할 수도 있습니다.
이 변수를default, verbose, terse의 어느 쪽인가에 설정하는 것으로 에러 보고의 장황성을 제어할 수 있습니다.
psql의 변수에는 정규의SQL문 중에서 사용 ("interpolate")할 수 있다고 하는 편리한 기능이 있습니다. 이 기능을 이용하려면 전술과 같이 변수명의 전에 구두점(:)을 부가해 주세요.
testdb=> \set foo 'my_table' testdb=> SELECT * FROM :foo;
이 예에서는 쿼리는 my_table테이블에 대해서 행해집니다. 변수의 값은 그대로 복사되므로 대응을 취할 수 없는 인용부호나 backslash 명령마저도 포함할 수가 있습니다. 삽입한 장소에서 변수가 전개되었을 때에 확실히 올바른 의미가 되도록 해야 합니다. 변수값의 어구는 인용부호로 둘러싸인SQL의 항목에서는 실행되지 않을 것입니다.
이 변수가 갈아넣고 기능은 연속하는 문장에 대해 이 편리함의 유명한 애플리케이션은 외부 키 시나리오를 구축하기 위해 뒤 따르는 명령 직전에 삽입된OID를 참조합니다. 그 밖에도 파일의 내용을 테이블열에 복사하는 경우도 이용할 수가 있습니다. 그 때는 파일을 우선 변수에 읽어들여 위와 같은 처리를 실시합니다.
testdb=> \set content '''' `cat my_file.txt` '''' testdb=> INSERT INTO my_table VALUES (:content);
이 방법에는 한개 문제가 있습니다. 그것은 my_file.txt에 단일 인용부호가 포함되어 있을 가능성이 있다고 하는 문제입니다. 상기의 두번째 행에 있어서의 구문 에러를 막기 위해서는 이 문자를 이스케이프 할 필요가 있습니다. sed프로그램을 사용해 다음과 같이 하면 단일 인용부호를 이스케이프 할 수가 있습니다.
testdb=> \set content '''' `sed -e "s/'/''/g" < my_file.txt` ''''
비표준준거의 캐릭터 라인을 사용하고 있다면 한층 더 backslash를 double backslash 수술을 하지 않으면 안됩니다. 이하와 같이 다소 까다로워집니다.
testdb=> \set content '''' `sed -e "s/'/''/g" -e 's/\\/\\\\/g' < my_file.txt` ''''
다른 쉘의 인용부호 기법을 사용하고 있는 것에 주의해 주세요. 이 단일 인용부호 기호나 backslash와도 쉘에는 특별한 것이 아닙니다. sed에 있어서는 특별한 의미를 가지기 때문에 backslash는 아직 double backslash 수술을 하지 않으면 안됩니다. (아마, 어떤 시점에 모든 Unix 명령가 동일한 이스케이프 문자를 사용하는 것은 훌륭하다고 생각했겠지요. )
구두점(:)도 SQL 명령 자체로 사용할 수 있으므로 다음의 규칙이 적용됩니다. "name"라고 하는 캐릭터 라인이 현시점에서 설정 끝난 변수명이 아닐 때는 ":name"라고 하는 캐릭터 라인은 변경되지 않습니다. 구두점을 backslash로 이스케이프 하면 항상 치환되지 않게 됩니다 (변수용의 구두점 구문은 ECPG와 같은 편입의 쿼리 언어용의SQL표준으로서 규정되고 있습니다. 배열의 일부와 형태 캐스트용의 구두점 구문은 PostgreSQL의 확장이며, 충돌하고 있습니다).
psql가 발행하는 prompt는 기호에 응해 커스터마이즈 할 수 있습니다. PROMPT1, PROMPT2, PROMPT3라고 하는 3개의 변수는 prompt의 표시 내용을 나타내는 캐릭터 라인이나 특별한 이스케이프 시퀀스를 가집니다. prompt 1은 psql가 새로운 명령을 받아들일 때에 발행되는 통상의 prompt입니다. prompt 2는 명령가 세미콜론으로 끝나지 않은 또는 인용부호가 덮지 않기 위해 한층 더 명령의 입력이 요구되고 있을 때에 발행됩니다. prompt 3은 SQL의COPY명령을 실행하고 있을 때, 또는 단말상에서 행의 값의 입력이 요구되고 있을 때에 발행됩니다.
선택된 prompt 변수의 값은 그대로 문자로서 표시됩니다. 다만, 퍼센트(%)가 포함되는 경우는 예외입니다. 이 경우는 다음의 문자에 따라, 특정의 텍스트에 치환됩니다. 치환 대상으로 정의되고 있는 것은 다음의 것입니다.
그 접속이 Unix 도메인 소켓의 경우 데이터 베이스 서버의(도메인명 첨부의) 완전한 호스트명이나 [local]가 됩니다. 다만, Unix 도메인 소켓이 컴파일시로 설정한 기본값의 장소에 존재하지 않는 경우는 [local: /dir/name ]가 됩니다.
그 접속이 Unix 도메인 소켓의 경우 첫번째 닷을 없애거나 데이터 베이스 서버의 호스트명이나 [local]가 됩니다.
데이터 베이스 서버가 감시하는 포트 번호입니다.
데이터베이스 세션 사용자 이름입니다 (이 값의 전개 결과는 SET SESSION AUTHORIZATION명령의 실행에 의해 데이터베이스 세션중으로 바뀔 수도 있습니다.).
접속중의 데이터베이스명입니다.
기본값에서는 데이터베이스의 경우에~(치르다)가 출력되는 점을 제외해%/과 같습니다.
세션 사용자가 데이터베이스 슈퍼 유저인 경우는 #, 그 이외의 경우는 >가 됩니다 (이 값의 전개 결과는 SET SESSION AUTHORIZATION명령의 실행에 의해 데이터베이스 세션중으로 바뀔 수도 있습니다.).
prompt 1의 경우, 통상은 =, 싱글행 모드에서는 ^, 데이터베이스와의 접속이 끊어진 세션에서는 ! (이)가 됩니다(\connect가 실패했을 경우에 발생합니다). prompt 2의 경우, -, *, 단일 인용부호, 이중 인용부호, 달러 기호로 옮겨집니다. 어느 문자로 옮겨질까는 psql가 입력을 기다리고 있는 이유(명령가 종료하고 있지 않는 /* ... */에 의한 코멘트행안에 있는 인용부호나 이스케이프 된 달러 기호안에 있다)에 의해 정해집니다. prompt 3의 경우, 그 시퀀스는 아무것도 실행되지 않습니다.
트랜잭션(transaction) 상태입니다. 트랜잭션(transaction) 블록의 밖에 있는 경우는 빈문자열에 트랜잭션(transaction) 블록안에 있는 경우는 *에 실패한 트랜잭션(transaction) 블록안에 있는 경우는 ! 에 (접속되어 있지 않은 등) 트랜잭션(transaction) 상태가 부정의 경우는 ? (이)가 됩니다.
지정 8진수치 코드의 문자에 치환됩니다.
psql의 name 변수의 값입니다. 자세한 것은 변수 을 참조해 주세요.
통상의"back-tick"에 의한 치환을 닮은 command 의 출력입니다.
프롬프트에는 단말 제어 문자를 포함할 수가 있습니다. 구체적으로는 색의 변경, 배경, prompt 텍스트의 양식, 단말 윈도우의 타이틀등을 지정할 수 있습니다. Readline의 행 편집 기능을 적절히 동작시키기 위해서는 인자되지 않는 제어 문자를%[과%]로 둘러싸, 불가시인 것을 명시해야 합니다. 이 기호의 편성은 프롬프트내에 복수 기술할 수가 있습니다. 이하에 예를 나타냅니다.
testdb=> \set PROMPT1 '%[%033[1;33;40m%]%n@%/%R%[%033[0m%]%# '
이것에 의해 VT100 호환의 배색 가능한 단말에서는 볼드 폰트로(1;), 황색으로 점멸하는(33;40) prompt가 표시됩니다.
prompt에 퍼센트 기호를 넣는 경우는 %%라고 기술해 주세요. 기본값의 prompt는 prompt 1으로 2에'%/%R%# ', prompt 3에'>> '를 설정했을 경우와 같습니다.
Note: 이 기능은 tcsh의 기능을 흉내낸 것입니다.
psql하행 내편집이나 반복해 입력이 간편하게 되도록 Readline라이브러리를 지원하고 있습니다. 명령 이력은 psql의 종료되고 리로드 될때, psql의 시작시에 자동적으로 저장됩니다. Tab-completion도 지원되고 있지만,SQL의 파서로서 명령을 해석하고 판단해 주는 것은 아닙니다. Tab-completion을 어떠한 사정에 의해 사용하고 싶지 않으면 홈 디렉토리 이하의. inputrc라고 하는 파일에 이하와 같이 기입하는 것으로 무효로 할 수 있습니다.
$if psql set disable-completion on $endif
(이것은 psql의 기능은 아니고,Readline의 기능입니다. 상세한 것에 대하여는 Readline의 문서를 참조해 주세요).
쿼리 결과가 화면에 들어가 자르지 않는 경우, 이 명령에 의해 결과를 파이프 합니다. 일반적으로 지정되는 값은 more, 또는 less입니다. 기본값에서는는 플랫폼에 따라서 다릅니다. pager의 사용을 금지하려면\pset명령을 사용합니다.
기본값에서는 접속하는 데이터베이스입니다.
기본값의 접속 매개변수입니다.
\e명령가 사용하는 에디터입니다. 변수는 이 리스트순서에 검색됩니다. 즉 최초로 설정된 것이 사용됩니다.
\! 명령이 실행하는 명령입니다.
일시파일을 저장하는 디렉토리입니다. 기본값에서는 /tmp입니다.
또, 이 유틸리티는 다른 대부분의PostgreSQL 유틸리티와 같이libpq로 지원되는 환경 변수를 사용합니다(Section 29.12를 참조해 주세요).
psql는 처리를 시작하기 전에 시스템 전체용의psqlrc파일과 사용자용의~/. psqlrc파일의 명령을 읽어들여 실행하려고 합니다 (Windows에 있어서의, 유저용의 기동 파일의 이름은 %APPDATA%\postgresql\psqlrc.conf입니다). 시스템 전체용의 파일의 설정에 관한 정보에 대해서는 PREFIX /share/psqlrc.sample를 참조해 주세요. \set나SET명령을 사용해 기호에 응한 클라이언트나 서버를 설정하기 위해서 사용할 수가 있습니다.
시스템 전체용의psqlrc파일과 사용자용의~/. psqlrc파일에 예를 들면~/. psqlrc-8.3.3와 같이 하이픈 기호와PostgreSQL의 릴리스 번호를 부여하는 것으로 특정 버젼전용의 파일로 할 수가 있습니다. 일치하는 버젼의 파일은 버젼 지정이 없는 파일보다 우선해 읽힙니다.
명령 라인 이력은 ~/. psql_history파일, Windows의 경우는 %APPDATA%\postgresql\psql_history에 저장됩니다.
구버젼의psql에서는 단일 문자의 backslash 명령의 뒤에 공백을 들어갈 수 있지 않고 직접 최초의 인수를 입력할 수가 있었습니다. 이 기능은 현재에도 호환성을 보관 유지하기 위해서 어느 정도는 지원되고 있지만, 추천 되지 않기 때문에 여기에서는 자세하게 설명하지 않습니다. 이상한 메세지가 표시되었을 경우는 이것을 생각해 내 주세요. 예를 들면
testdb=> \foo Field separator is "oo".
실행결과가 기대 한 것이 아닐수도 있습니다.
psql가 원활히 동작하는 것은 동일 버젼의 서버가 대상일때만입니다. 다른 버젼의 편성에서는 전혀 움직이지 않는다고 하는 의미가 아니지만, 대소의 여러가지 문제가 발생할 가능성이 있습니다. 특히 backslash 명령은 서버의 버젼이 다르면 실패하기 쉬워집니다.
psql는 "console application"으로서 컴파일 됩니다. Windows의 콘솔 윈도우는 시스템의 다른 부분과는 다른 encode 방식을 사용하고 있으므로psql로 8 비트 문자를 사용할 때에는 특별한 배려가 필요합니다. psql는 콘솔용 code page로서 문제가 있는 것을 검출하면 시작시에 경고를 발표합니다. 콘솔용 code page를 변경하기 위해서는 이하의 2개가 필요합니다.
cmd.exe /c chcp 1252라고 입력해 코드 페이지를 설정합니다 (1252는 독일권에 있어서의 적절한 코드 페이지입니다. 시스템에 맞추어 변경해 주세요). Cygwin를 사용하고 있다면 이 명령을/etc/profile에 추가해 주세요.
콘솔용 폰트를Lucida Console로 설정해 주세요. 점방식 폰트는 ANSI 코드 페이지에서는 올바르게 동작하지 않기 때문입니다.
최초로 복수행에 걸치는 명령의 입력예를 나타냅니다. 프롬프트의 변화에 주의해 주세요.
testdb=> CREATE TABLE my_table ( testdb(> first integer not null default 0, testdb(> second text) testdb-> ; CREATE TABLE
그런데, 여기서 테이블 정의를 재차 확인해 보겠습니다.
testdb=> \d my_table
Table "my_table"
Attribute | Type | Modifier
-----------+---------+--------------------
first | integer | not null default 0
second | text |
다음에 프롬프트를 좀 더 재미있는 것으로 변경해 보겠습니다.
testdb=> \set PROMPT1 '%n@%m %~%R%# ' peter@localhost testdb=>
테이블에 데이터를 입력한 것이라고 생각해 주세요. 데이터를 보는 경우는 다음과 같이 합니다.
peter@localhost testdb=> SELECT * FROM my_table;
first | second
-------+--------
1 | one
2 | two
3 | three
4 | four
(4 rows)
\pset명령을 사용해 이 테이블의 표시를 다른 타입으로 변경할 수가 있습니다.
peter@localhost testdb=> \pset border 2
Border style is 2.
peter@localhost testdb=> SELECT * FROM my_table;
+-------+--------+
| first | second |
+-------+--------+
| 1 | one |
| 2 | two |
| 3 | three |
| 4 | four |
+-------+--------+
(4 rows)
peter@localhost testdb=> \pset border 0
Border style is 0.
peter@localhost testdb=> SELECT * FROM my_table;
first second
----- ------
1 one
2 two
3 three
4 four
(4 rows)
peter@localhost testdb=> \pset border 1
Border style is 1.
peter@localhost testdb=> \pset format unaligned
Output format is unaligned.
peter@localhost testdb=> \pset fieldsep ","
Field separator is ",".
peter@localhost testdb=> \pset tuples_only
Showing only tuples.
peter@localhost testdb=> SELECT second, first FROM my_table;
one,1
two,2
three,3
four,4
그 외의 방법으로서 단축된 명령을 사용해 보겠습니다.
peter@localhost testdb=> \a \t \x Output format is aligned. Tuples only is off. Expanded display is on. peter@localhost testdb=> SELECT * FROM my_table; -[ RECORD 1 ]- first | 1 second | one -[ RECORD 2 ]- first | 2 second | two -[ RECORD 3 ]- first | 3 second | three -[ RECORD 4 ]- first | 4 second | four