CopylệnhTheCopylệ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. Các chức tỷ lệ kèo bóng đá được mô tả trong phần này cho phép các ứng dụng tận dụng khả tỷ lệ kèo bó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 SQLCopyLệnh quaPQEXEChoặc một trong các chứ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_OUThoặ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 chứ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. Khi truyền dữ liệu hoàn tất, một người khácpgresultĐố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_ERRORNế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 khiCopyHoạt động đang được tiến hành.)
Nếu ACopylệnh được cấp quaPQEXECTrong 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ả quaPQGetResultSau khi hoàn thànhCopyTrình tự. Chỉ khiPQGetResultreturnnullCó chắc chắn rằngPQEXECChuỗ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_OUThoặcPGRES_COPY_INtừPQEXEChoặcPQGetResult.
Apgresult14773_14857CopyHoạ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 cột, 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. Nhìn thấyCopyĐể biết thêm thông tin.
PQFFormat 16094_16397Copy, 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.)
Các giá trị dữ liệu bổ sung này chỉ khả dụng khi sử dụng Giao thức 3.0. Khi sử dụng Giao thức 2.0, tất cả các chức tỷ lệ kèo bóng đá này sẽ trả về 0.
CopyDataCác chức tỷ lệ kèo bóng đá này được sử dụng để gửi dữ liệu trongSao chép từ Stdin17126_17185copy_inState.
PQPutCopydata Gửi dữ tỷ lệ kèo bóng đá đến máy chủ trong thời giancopy_inBang.
17626_17730
TruyềnCopyDữ tỷ lệ kèo bóng đá trong được chỉ địnhbộ đệm, của độ 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. (Sử dụngpqerrormessageĐể 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ể chiaCopyluồ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. Nội dung của luồng dữ tỷ lệ kèo bóng đá phải khớp với định dạng dữ tỷ lệ kèo bóng đá được dự kiến bởiCopylệnh; nhìn thấyCopyĐể biết chi tiết.
pqputcopyend Gửi chỉ báo cuối cùng vào máy chủ trong khicopy_inState.
int pqputcopyend (pgconn *Conn,
const char *errormsg);
tỷ lệ kèo bóng đá thúccopy_inHoạt động thành công nếuerrormsglànull. Nếu nhưerrormsgkhông phảinullSau đóCopybị 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ạisao chépvì lý do riêng của nó. Cũng lưu ý rằng tùy chọn buộc lỗi không hoạt động khi sử dụng tỷ lệ kèo bóng đá nối Pre-3.0-giao thức.)
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. .pqflush20177_20404pqputcopyendgọ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ủaCopyLệ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. Sau đó trở lại hoạt động bình thường.
CopyDataNhững chứ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_outBang.
PQGetCopydata Nhận dữ tỷ lệ kèo bóng đá từ máy chủ trongcopy_outBang.
int PQGetCopydata (PGConn *Conn,
Char ** Buffer,
int async);
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 gianCopy22009_22209bộ đệmtham số phải khôngnull. *bộ đệmđược đặt để trỏ đến bộ nhớ được phân bổ hoặc đếnnullTrong trường hợp không trả lại bộ đệm. Không phải22503_22509Bộ đệm tỷ lệ kèo bóng đá quả phải được giải phóng bằng cách sử dụngPQFreememKhi 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ằngCopyvẫ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ể khiasynclà đú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ảopqerrormessageVì lý do).
Khi23345_23352là đúng (không phải bằng không),PQGetCopydatasẽ không chặn chờ nhập; nó sẽ trả về 0 nếusao chépvẫ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ọiPQConsumeInputTrước khi gọiPQGetCopydataMột lần nữa.) Khiasynclà sai (không),PQGetCopydataSẽ chặn cho đến khi dữ tỷ lệ kèo bóng đá có sẵn hoặc hoạt động hoàn thành.
sauPQGetCopydatareturn -1, gọiPQGetResultĐể có được trạng thái tỷ lệ kèo bóng đá quả cuối cùng củaCopylệ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. Sau đó trở lại hoạt động bình thường.
CopyCác chứ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ướcLEGN.
int PQGetLine (PGConn *Conn,
Char *bộ đệm,
int length);
Hàm này sao chép lênLEGN-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.PQGetLinereturnEOFỞ 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 tỷ lệ kèo bóng đá thúc 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ủaCopyLệ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\.26184_26289
PQGetLineAsync Đọc một hàngCopyDữ 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,
Char *bộ đệm,
int bufsize);
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 đọcCopyDữ tỷ lệ kèo bóng đá không đồng bộ, nghĩa là không chặn. Đã phát hànhCopyLệnh và nhận đượcPGRES_COPY_OUTPhản hồi, ứng dụng nên gọiPQConsumeInputvàPQGetLineAsyncCho đế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,PQGetLineAsyncSẽ trả về dữ tỷ lệ kèo bóng đá nếu hàng dữ tỷ lệ kèo bóng đá hoàn chỉnh có sẵn tronglibpq27589_27891PQENDCOPY, và 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. Nhưng nếu bộ đệm do người gọi cung cấp quá nhỏ để giữ một hàng được gửi bởi máy chủ, thì một hàng dữ tỷ lệ kèo bóng đá một phần sẽ được trả về. Với dữ tỷ lệ kèo bóng đá văn bản, điều này có thể được phát hiện bằng cách kiểm tra xem byte cuối cùng được trả về là\ nhay 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 qua28654_28663Mộ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àEOFNếu không thể gửi chuỗi.
int pqputline (PGConn *Conn,
const char *chuỗi);
TheCopy29238_29282pqputlinecó 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ỗipqputlinecuộ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 hai ký tự một cách rõ ràng\.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ửiCopyDữ 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ó đủ để gọiPQENDCOPYSau 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àEOFNếu không thể gửi chuỗi.
int pqputnbytes (pgconn *Conn,
const char *bộ đệm,
int nbytes);
Điều này giống hệtpqputline, ngoại trừ việc không cần phải tỷ lệ kèo bóng đá thúc bộ đệm dữ liệu do 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ụngpqputlinehoặc khi chuỗi cuối cùng được nhận từ máy chủ bằng cách sử dụngPQGetLine31603_31648HồiOut of SyncHàngVới máy khách. Khi trở về từ chức tỷ lệ kèo bóng đá này, máy chủ đã sẵn sàng nhận lệnh SQL tiếp theo. Giá trị trả về là 0 khi hoàn thành thành công, khác không. (Sử dụngpqerrormessageĐể 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_OUTtỷ lệ kèo bóng đá quả bằng cách thực thiPQGetLineCàng lặp đi lặp lại, theo sau làPQENDCOPYSau khi thấy dòng Terminator được nhìn thấy. Sau đó nó sẽ trở lạiPQGetResultVòng lặp cho đếnPQGetResultTrả về một con trỏ null. Tương tự APGRES_COPY_INtỷ lệ kèo bóng đá quả được xử lý bởi một loạtpqputlinecuộc gọi theo sau làPQENDCOPY, sau đó quay lạiPQGetResultVòng lặp. Sự sắp xếp này sẽ đảm bảo rằngCopyLệ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ả tỷ lệ kèo bóng đá gửiCopyViaPQEXECvà 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ếuCopylà duy nhấtSQLLệnh trong chuỗi lệnh.