Copy
lệnh#Thesao chép
lệnh trongPostgreSQLCó các tùy chọn để đọc hoặc ghi vào tỷ lệ kèo bóng đá nối mạng được sử dụng bởilibpq. tỷ lệ kèo bóng đá mô tả trong phần này cho phép các ứng dụng tận dụng khả năng này bằng cách cung cấp hoặc tiêu thụ dữ liệu được sao chép.
Quy trình tổng thể là ứng dụng đầu tiên phát hành SQLsao chép
lệnh thông quaPQEXEC
hoặc một trong các tỷ lệ kèo bóng đá tương đương. Phản hồi cho điều này (nếu không có lỗi trong lệnh) sẽ làpgresult
Đối tượng mang mã trạng thái củaPGRES_COPY_OUT
hoặcPGRES_COPY_IN
(tùy thuộc vào hướng sao chép được chỉ định). Sau đó, ứng dụng nên sử dụng các tỷ lệ kèo bóng đá của phần này để nhận hoặc truyền các hàng dữ liệu.PGRESULT
Đối tượng được trả về để biểu thị thành công hoặc thất bại của việc chuyển nhượng. Trạng thái của nó sẽ làPGRES_COMMAND_OK
Để thành công hoặcpgres_fatal_error
Nếu gặp một số vấn đề. Tại thời điểm này, các lệnh SQL có thể được cấp quaPQEXEC
. (Không thể thực thi các lệnh SQL khác bằng cùng một tỷ lệ kèo bóng đá nối trong khiCopy
Hoạt động đang được tiến hành.)
Nếu ACopy
Lệnh được cấp quaPQEXEC
Trong một chuỗi có thể chứa các lệnh bổ sung, ứng dụng phải tiếp tục tìm nạp tỷ lệ kèo bóng đá quả quaPQGetResult
Sau khi hoàn thànhCopy
Trình tự. Chỉ khiPQGetResult
returnnull
Có chắc chắn rằngPQEXEC
Chuỗi lệnh được thực hiện và an toàn khi đưa ra nhiều lệnh hơn.
Các chức năng của phần này chỉ được thực thi sau khi có được trạng thái tỷ lệ kèo bóng đá quả củaPGRES_COPY_OUT
hoặcPGRES_COPY_IN
từPQEXEC
hoặcPQGetResult
.
APGRESULT
Đối tượng mang một trong những giá trị trạng thái này mang một số dữ tỷ lệ kèo bóng đá bổ sung vềCopy
Hoạt động đang bắt đầu. Dữ liệu bổ sung này có sẵn bằng cách sử dụng các chức năng cũng được sử dụng liên quan đến tỷ lệ kèo bóng đá quả truy vấn:
PQNFields
#Trả về số lượng cột (trường) sẽ được sao chép.
PQBinaryTuples
#0 Cho biết định dạng bản sao tổng thể là văn bản (các hàng được phân tách bằng các đường mới, các cột được phân tách bởi các ký tự phân cách, v.v.). 1 Cho biết định dạng bản sao tổng thể là nhị phân.CopyĐể biết thêm thông tin.
PQFFormat
#Trả về mã định dạng (0 cho văn bản, 1 cho nhị phân) được liên tỷ lệ kèo bóng đá với mỗi cột của hoạt động sao chép. Các mã định dạng trên mỗi cột sẽ luôn bằng không khi định dạng bản sao tổng thể là văn bản, nhưng định dạng nhị phân có thể hỗ trợ cả cột văn bản và nhị phân.Copy
, chỉ các cột nhị phân xuất hiện trong một bản sao nhị phân; Vì vậy, các định dạng trên mỗi cột luôn phù hợp với định dạng tổng thể hiện tại.)
Copy
Data#Các tỷ lệ kèo bóng đá này được sử dụng để gửi dữ liệu trongSao chép từ Stdin
. Họ sẽ thất bại nếu được gọi khi tỷ lệ kèo bóng đá nối không ởcopy_in
Bang.
PQPutCopydata
#Gửi dữ tỷ lệ kèo bóng đá đến máy chủ trong khicopy_in
State.
int pqputcopydata (pgconn *Conn,
TruyềnCopy
Dữ tỷ lệ kèo bóng đá trong được chỉ địnhbộ đệm
, độ dàinbyte
, đến máy chủ. tỷ lệ kèo bóng đá quả là 1 nếu dữ liệu được xếp hàng, 0 nếu nó không được xếp hàng vì bộ đệm đầy đủ (điều này sẽ chỉ xảy ra ở chế độ không chặn) hoặc -1 nếu xảy ra lỗi.pqerrormessage
Để truy xuất chi tiết nếu giá trị trả về là -1. Nếu giá trị bằng không, hãy đợi để viết sẵn và thử lại.)
Ứng dụng có thể chiaCopy
luồng dữ tỷ lệ kèo bóng đá thành tải bộ đệm của bất kỳ kích thước thuận tiện nào. Ranh giới tải bộ đệm không có ý nghĩa ngữ nghĩa khi gửi.Copy
lệnh; nhìn thấyCopyĐể biết chi tiết.
pqputcopyend
#Gửi chỉ số cuối dữ tỷ lệ kèo bóng đá đến máy chủ trong thời giancopy_in
Bang.
int pqputcopyend (pgconn *Conn,
tỷ lệ kèo bóng đá thúccopy_in
Hoạt động thành công nếuerrormsg
lànull
. Nếu nhưerrormsg
không phảinull
sau đósao chép
bị buộc phải thất bại, với chuỗi được trỏ bởierrormsg
Được sử dụng làm thông báo lỗi. (Tuy nhiên, người ta không nên cho rằng thông báo lỗi chính xác này sẽ quay lại từ máy chủ, vì máy chủ có thể đã thất bạiCopy
vì lý do riêng của nó.)
tỷ lệ kèo bóng đá quả là 1 nếu thông báo chấm dứt được gửi; hoặc trong chế độ không chặn, điều này chỉ có thể chỉ ra rằng thông báo chấm dứt đã được xếp hàng thành công.PQFLUSH
, lặp lại cho đến khi nó trả về 0.) Số 0 chỉ ra rằng hàm không thể xếp hàng thông báo chấm dứt vì bộ đệm đầy đủ; Điều này sẽ chỉ xảy ra trong chế độ không chặn.pqputcopyend
gọi lại.) Nếu xảy ra lỗi khó xảy ra, -1 được trả về; Bạn có thể sử dụngpqerrormessage
Để lấy chi tiết.
Sau khi gọi thành côngpqputcopyend
, gọiPQGetResult
Để có được trạng thái tỷ lệ kèo bóng đá quả cuối cùng củaCopy
Lệnh. Người ta có thể chờ tỷ lệ kèo bóng đá quả này có sẵn theo cách thông thường.
Copy
Data#Các tỷ lệ kèo bóng đá này được sử dụng để nhận dữ liệu trongSao chép vào stdout
. Họ sẽ thất bại nếu được gọi khi tỷ lệ kèo bóng đá nối không ởcopy_out
Bang.
PQGetCopydata
#Nhận dữ tỷ lệ kèo bóng đá từ máy chủ trongcopy_out
Bang.
int PQGetCopydata (PGConn *Conn,
cố gắng lấy một hàng dữ tỷ lệ kèo bóng đá khác từ máy chủ trong thời gianCopy
. Dữ tỷ lệ kèo bóng đá luôn được trả về một hàng dữ tỷ lệ kèo bóng đá tại một thời điểm;bộ đệm
tham số phải khôngnull
. *bộ đệm
được đặt để trỏ đến bộ nhớ được phân bổ hoặc đếnnull
Trong trường hợp không trả lại bộ đệm. Không phảinull
Bộ đệm tỷ lệ kèo bóng đá quả phải được giải phóng bằng cách sử dụngPQFreemem
Khi không cần thiết.
Khi một hàng được trả về thành công, giá trị trả về là số byte dữ tỷ lệ kèo bóng đá trong hàng (điều này sẽ luôn lớn hơn 0). Chuỗi được trả về luôn được chấm dứt, mặc dù điều này có lẽ chỉ hữu ích cho văn bảnCopy
. tỷ lệ kèo bóng đá quả của 0 chỉ ra rằngCopy
vẫn đang được tiến hành, nhưng chưa có hàng nào có sẵn (điều này chỉ có thể khiasync
là đúng). tỷ lệ kèo bóng đá quả của -1 chỉ ra rằngCopy
được thực hiện. tỷ lệ kèo bóng đá quả của -2 chỉ ra rằng xảy ra lỗi (tham khảopqerrormessage
Vì lý do).
khiAsync
là đúng (không phải bằng không),PQGetCopydata
sẽ không chặn chờ đầu vào; nó sẽ trả về 0 nếuCopy
vẫn đang được tiến hành nhưng không có hàng hoàn chỉnh nào có sẵn. (Trong trường hợp này, hãy đợi sẵn sàng đọc và sau đó gọiPQConsumeInput
Trước khi gọiPQGetCopydata
Một lần nữa.) KhiAsync
là sai (không),PQGetCopydata
Sẽ chặn cho đến khi dữ tỷ lệ kèo bóng đá có sẵn hoặc hoạt động hoàn thành.
sauPQGetCopydata
return -1, gọiPQGetResult
Để có được trạng thái tỷ lệ kèo bóng đá quả cuối cùng củaCopy
lệnh. Người ta có thể chờ tỷ lệ kèo bóng đá quả này có sẵn theo cách thông thường.
Copy
#Các tỷ lệ kèo bóng đá này đại diện cho các phương thức xử lý cũ hơnCopy
. Mặc dù chúng vẫn hoạt động, nhưng chúng không được xử lý do xử lý lỗi kém, các phương pháp bất tiện trong việc phát hiện tỷ lệ kèo bóng đá thúc dữ liệu và thiếu hỗ trợ cho việc chuyển nhượng nhị phân hoặc không chặn.
PQGetLine
#Đọc một dòng ký tự tỷ lệ kèo bóng đá thúc mới (được truyền bởi máy chủ) vào một chuỗi bộ đệm có kích thướclength
.
int PQGetLine (PGConn *Conn,
Hàm này sao chép lênlength
-1 ký tự thành bộ đệm và chuyển đổi dòng mới tỷ lệ kèo bóng đá thúc thành một byte số 0.PQGetLine
returnEOF
Ở cuối đầu vào, 0 nếu toàn bộ dòng đã được đọc và 1 nếu bộ đệm đầy đủ nhưng dòng mới chưa được đọc.
Lưu ý rằng ứng dụng phải kiểm tra xem một dòng mới có bao gồm hai ký tự\.
, trong đó chỉ ra rằng máy chủ đã hoàn thành việc gửi tỷ lệ kèo bóng đá quả củaCopy
Lệnh. Nếu ứng dụng có thể nhận các dòng nhiều hơnlength
-1 ký tự dài, cần phải quan tâm để chắc chắn rằng nó nhận ra\.
27757_27862
PQGetLineAsync
#Đọc một hàngCopy
Dữ tỷ lệ kèo bóng đá (được truyền bởi máy chủ) vào bộ đệm mà không chặn.
int PQGetLineAnyNC (PGConn *Conn,
Hàm này tương tựPQGetLine
, nhưng nó có thể được sử dụng bởi các ứng dụng phải đọcCopy
Dữ tỷ lệ kèo bóng đá không đồng bộ, nghĩa là không chặn. Đã phát hànhCopy
Lệnh và nhận đượcPGRES_COPY_OUT
Phản hồi, ứng dụng nên gọiPQConsumeInput
vàPQGetLineAsync
Cho đến khi phát hiện tín hiệu cuối cùng của dữ tỷ lệ kèo bóng đá.
Không giống nhưPQGetLine
, Hàm này chịu trách nhiệm phát hiện tỷ lệ kèo bóng đá thúc dữ liệu.
Trên mỗi cuộc gọi,PQGetLineAsync
Sẽ trả về dữ tỷ lệ kèo bóng đá nếu có sẵn hàng dữ tỷ lệ kèo bóng đá hoàn chỉnh tronglibpqbộ đệm đầu vào. Mặt khác, không có dữ tỷ lệ kèo bóng đá nào được trả về cho đến khi phần còn lại của hàng đến.PQENDCOPY
, sau đó trở lại xử lý bình thường.
Dữ tỷ lệ kèo bóng đá được trả về sẽ không vượt ra ngoài ranh giới hàng dữ tỷ lệ kèo bóng đá. Nếu có thể một hàng toàn bộ sẽ được trả lại cùng một lúc.\ n
hay không. (Trong một nhị phânCopy
, Phân tích cú pháp thực tế củaCopy
Định dạng dữ tỷ lệ kèo bóng đá sẽ cần thiết để đưa ra quyết định tương đương.) Chuỗi được trả về không được chấm dứt. (Nếu bạn muốn thêm NULL chấm dứt, hãy chắc chắn vượt quaBufsize
Một nhỏ hơn phòng thực sự có sẵn.)
pqputline
#Gửi một chuỗi tỷ lệ kèo bóng đá thúc null đến máy chủ. Trả về 0 nếu ok vàEOF
Nếu không thể gửi chuỗi.
int pqputline (PGConn *Conn,
TheCopy
luồng dữ tỷ lệ kèo bóng đá được gửi bởi một loạt các cuộc gọi đếnpqputline
có cùng định dạng như được trả về bởiPQGetLineAsync
, ngoại trừ các ứng dụng không bắt buộc phải gửi chính xác một hàng dữ tỷ lệ kèo bóng đá trên mỗipqputline
cuộc gọi; Không sao khi gửi một dòng một phần hoặc nhiều dòng cho mỗi cuộc gọi.
trướcPostgreSQLGiao thức 3.0, ứng dụng cần phải gửi rõ ràng hai ký tự\.
Là một dòng cuối cùng để chỉ ra với máy chủ rằng nó đã hoàn thành việc gửiCopy
Dữ tỷ lệ kèo bóng đá. Mặc dù điều này vẫn hoạt động, nó không được chấp nhận và ý nghĩa đặc biệt của\.
có thể được loại bỏ trong một bản phát hành trong tương lai. (Nó đã bị sai trongCSV
chế độ.) Nó là đủ để gọiPQENDCOPY
Sau khi gửi dữ tỷ lệ kèo bóng đá thực tế.
pqputnbytes
#Gửi chuỗi không tỷ lệ kèo bóng đá thúc không đến máy chủ. Trả về 0 nếu ok vàEOF
Nếu không thể gửi chuỗi.
int pqputnbytes (pgconn *Conn,
Điều này giống hệtpqputline
, ngoại trừ bộ đệm dữ liệu không cần phải tỷ lệ kèo bóng đá thúc vì số lượng byte gửi được chỉ định trực tiếp. Sử dụng quy trình này khi gửi dữ liệu nhị phân.
PQENDCOPY
#Đồng bộ hóa với máy chủ.
int pqendcopy (pgconn *Conn);
Hàm này đợi cho đến khi máy chủ hoàn thành việc sao chép. Nó sẽ được cấp khi chuỗi cuối cùng được gửi đến máy chủ bằng cách sử dụngpqputline
hoặc khi chuỗi cuối cùng được nhận từ máy chủ bằng cách sử dụngPQGetLine
. Nó phải được cấp hoặc máy chủ sẽ nhận đượcOut of SyncVới máy khách. Khi trở về từ tỷ lệ kèo bóng đá này, máy chủ đã sẵn sàng nhận lệnh SQL tiếp theo.pqerrormessage
Để lấy chi tiết nếu giá trị trả về không khác.)
Khi sử dụngPQGetResult
, Ứng dụng sẽ trả lờiPGRES_COPY_OUT
tỷ lệ kèo bóng đá quả bằng cách thực thiPQGetLine
Liên tục, theo sau làPQENDCOPY
Sau khi thấy dòng Terminator được nhìn thấy. Sau đó nó sẽ trở lạiPQGetResult
Vòng lặp cho đếnPQGetResult
Trả về một con trỏ null. Tương tự APGRES_COPY_IN
tỷ lệ kèo bóng đá quả được xử lý bởi một loạtpqputline
cuộc gọi theo sau làPQENDCOPY
, sau đó quay lạiPQGetResult
Vòng lặp. Sự sắp xếp này sẽ đảm bảo rằngCopy
Lệnh được nhúng trong một loạtSQLCác lệnh sẽ được thực thi chính xác.
Các ứng dụng cũ có khả năng gửi ACopy
ViaPQEXEC
và giả sử rằng giao dịch được thực hiện sauPQENDCOPY
. Điều này sẽ chỉ hoạt động chính xác nếuCopy
là duy nhấtSQLLệnh trong chuỗi lệnh.