27.8. Các chức năng được liên cách đọc kèo bóng đá vớiCopylệnh

Gửi dữ cách đọc kèo bóng đá đến máy chủ trong thời giancopy_inBang.

int pqputcopydata (pgconn *Conn,
                  const char *bộ đệm,
                  int nbytes);

TruyềnCopyDữ cách đọc kèo bóng đá trong được chỉ địnhbộ đệm, của chiều dàinbyte, đến máy chủ. cách đọc kèo bóng đá quả là 1 nếu dữ liệu được gửi, không nếu nó không được gửi bởi vì nỗ lực sẽ chặn (trường hợp này chỉ là có thể nếu cách đọc kèo bóng đá nối ở chế độ không chặn) hoặc -1 Nếu xảy ra lỗi. (Sử dụngpqerrormessageĐể lấy 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ữ cách đọc kèo bóng đá thành tải bộ đệm của bất kỳ Kích thước thuận tiện. Ranh giới tải bộ đệm không có ngữ nghĩa ý nghĩa khi gửi. Nội dung của dữ cách đọc kèo bóng đá luồng phải khớp với định dạng dữ cách đọc kèo bóng đá dự kiến ​​bởiCopylệnh; nhìn thấyCopyĐể biết chi tiết.

Gửi chỉ số cuối dữ cách đọc kèo bóng đá đến máy chủ trong khicopy_inBang.

int pqputcopyend (pgconn *Conn,
                 const char *errormsg);

cách đọc kèo bóng đá thúccopy_inHoạt động Thành công nếuerrormsglànull. Nếu như18044_18054khô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 lỗi tin nhắn. (Người ta không nên cho rằng lỗi chính xác này Tin nhắn sẽ trở lại từ máy chủ, tuy nhiên, máy chủ có thể đã thất bạiCopyvì 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 cách đọc kèo bóng đá nối Pre-3.0 Protocol.)

cách đọc kèo bóng đá quả là 1 nếu dữ liệu chấm dứt được gửi, không Nếu nó không được gửi vì nỗ lực sẽ chặn (cái này trường hợp chỉ có thể nếu cách đọc kèo bóng đá nối không bị chặn chế độ), hoặc -1 nếu xảy ra lỗi. (Sử dụngpqerrormessageĐể lấy 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.)

Sau khi gọi thành côngpqputcopyend, gọiPQGetResult19222_19276Copylệnh. Một có thể đợi cách đọc kèo bóng đá quả này có sẵn trong thông thường đường. Sau đó trở lại hoạt động bình thường.

Nhận dữ cách đọc 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ữ cách đọc kèo bóng đá khác từ máy chủ Trong mộtCopy. Dữ cách đọc kèo bóng đá luôn luôn trả lại một hàng dữ cách đọc kèo bóng đá tại một thời điểm; Nếu chỉ một hàng một phần là Có sẵn, nó không được trả lại. Sự trở lại thành công của một Hàng dữ cách đọc kèo bóng đá liên quan đến việc phân bổ một khối bộ nhớ để giữ dữ cách đọc kèo bóng đá. Thebộ đệmTham số Phải khôngnull. *bộ đệmđược đặt thành chỉ vào phân bổ bộ nhớ hoặc đếnnullTrong trường hợp Không có bộ đệm được trả lại. Không phảinullBộ đệm cách đọc 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ố lượng byte dữ liệu trong hàng (điều này sẽ luôn luôn lớn hơn 0). Chuỗi được trả về luôn luôn là cách đọc kèo bóng đá thúc null, mặc dù điều này có lẽ chỉ hữu ích cho TextualCopy. cách đọc kèo bóng đá quả của số không chỉ ra rằngCopyvẫn còn trong tiến trình, nhưng chưa có hàng nào có sẵn (điều này chỉ là có thể khiAsynclà đúng). cách đọc kèo bóng đá quả của -1 chỉ ra rằngCopyđược thực hiện. cách đọc kèo bóng đá quả của -2 chỉ ra rằng một lỗi đã xảy ra (tham khảopqerrormessageVì lý do).

KhiAsynclà đúng (không không),PQGetCopydataWill không chặn chờ đầu vào; nó sẽ trả về 0 nếuCopyvẫn đang được tiến hành nhưng không có Hàng hoàn chỉnh có sẵn. (Trong trường hợp này, hãy đợi Read-Ready và sau đó gọiPQConsumeInputTrước khi gọiPQGetCopydataMột lần nữa.) KhiAsynclà sai (không),PQGetCopydataSẽ chặn Cho đến khi dữ cách đọc kèo bóng đá có sẵn hoặc hoạt động hoàn thành.

sauPQGetCopydatareturn -1, gọiPQGetResultĐể có được cách đọc kèo bóng đá quả cuối cùng trạng thái củaCopyLệnh. Một có thể đợi cách đọc kèo bóng đá quả này có sẵn trong thông thường đường. Sau đó trở lại hoạt động bình thường.

Đọc một dòng ký tự cách đọc kèo bóng đá thúc mới (được truyền bởi máy chủ) vào chuỗi bộ đệm có kích thướclength.

int PQGetLine (PGConn *Conn,
              Char *bộ đệm,
              int length);

Hàm này sao chép lênLEGN-1 ký tự vào bộ đệm và Chuyển đổi việc chấm dứt dòng mới thành một byte số 0.PQGetLinereturnEOF24129_24287

Lưu ý rằng ứng dụng phải kiểm tra xem có phải mới dòng bao gồm hai ký tự\., trong đó chỉ ra rằng máy chủ có Đã hoàn thành việc gửi cách đọc kèo bóng đá quả củaCopyLệnh. Nếu ứng dụng có thể nhận cách đọc kèo bóng đá dòng nhiều hơnlength24687_24763\.dòng chính xác (và không, ví dụ, sai lầm cách đọc kèo bóng đá thúc một dòng dữ liệu dài cho một dòng Terminator).

Đọc một hàngCopy25110_25197

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ách đọc kèo bóng đá ứng dụng phải đọcCopyDữ cách đọc kèo bóng đá không đồng bộ, nghĩa là không chặn. Có đã ban hànhCopyLệnh và Got Apgres_copy_outPhản hồi, ứng dụng nên gọi25792_25808vàPQGetLineAsync25873_25927

Không giống nhưPQGetLine, Điều này chức năng chịu trách nhiệm phát hiện cách đọc kèo bóng đá thúc dữ liệu.

trên mỗi cuộc gọi,PQGetLineAsyncsẽ trả về dữ cách đọc kèo bóng đá nếu a Hàng dữ cách đọc kèo bóng đá hoàn chỉnh có sẵn tronglibpqbộ đệm đầu vào. Nếu không, không Dữ liệu được trả về cho đến khi phần còn lại của hàng đến. cách đọc kèo bóng đá chức năng trả về -1 nếu điểm đánh dấu dữ liệu cuối sao được công nhận hoặc 0 nếu không có dữ liệu hoặc Số dương cho số byte dữ liệu trả lại. Nếu -1 được trả về, người gọi phải gọi tiếp theoPQENDCOPY, sau đó trả về để xử lý bình thường.

Dữ cách đọc kèo bóng đá được trả về sẽ không mở rộng ra khỏi hàng dữ cách đọc kèo bóng đá ranh giới. Nếu có thể, toàn bộ hàng sẽ được trả lại tại một thời gian. Nhưng nếu bộ đệm do người gọi cung cấp cũng vậy nhỏ để giữ một hàng được gửi bởi máy chủ, sau đó là một phần Hàng dữ cách đọc kèo bóng đá sẽ được trả về. Với dữ cách đọc 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 trả về cuối cùng là\ nhoặc không. (Trong một nhị phânCopy, Phân tích cú pháp thực tế củaCopyĐịnh dạng dữ cách đọc kèo bóng đá sẽ cần để đưa ra quyết định tương đương.) Chuỗi không được chấm dứt. (Nếu bạn muốn thêm một chấm dứt null, hãy chắc chắn vượt quaBufsizeMột nhỏ hơn phòng thực sự có sẵn.)

Gửi một chuỗi cách đọc kèo bóng đá thúc null đến máy chủ. Trả lại 0 nếu ok vàEOFNếu không thể gửi chuỗi.

int pqputline (PGConn *Conn,
              const char *chuỗi);

TheCopyluồng dữ liệu được gửi bởi một loạt cách đọc kèo bóng đá cuộc gọi đếnpqputlinecó định dạng giống như như vậy Được trả về bởiPQGetLineAsync,, ngoại trừ cách đọc kèo bóng đá ứng dụng không bắt buộc phải gửi chính xác một hàng dữ liệu trên mỗipqputlinecuộc gọi; Bạn có thể gửi một dòng một phần hoặc nhiều dòng mỗi cuộc gọi.

Gửi chuỗi không cách đọc 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ừ bộ đệm dữ liệu không cần phải cách đọc 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.

Đồng bộ hóa với máy chủ.

int pqendcopy (pgconn *Conn);

chức cách đọc kèo bóng đá này đợi cho đến khi máy chủ hoàn thành 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ó được nhận từ máy chủ bằng cách đọc kèo bóng đá sử dụngPGGetLine. Nó phải được phát hành hoặc Máy chủ sẽ nhận được"Out of Sync"Với máy khách. Khi trở về từ chức năng này, Máy chủ đã sẵn sàng để nhận lệnh SQL tiếp theo. cách đọc kèo bóng đá Giá trị trở lại là 0 khi hoàn thành thành công, không nếu không thì. (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_OUTcách đọc kèo bóng đá quả bằng cách thực thiPQGetLinenhiều lần, theo sau làPQENDCOPYsau dòng Terminator được nhìn thấy. Sau đó nó sẽ trở lạiPQGetResultVòng lặp cho đếnPQGetResultTrả về một null con trỏ. Tương tự APGRES_COPY_INcách đọc kèo bóng đá quả được xử lý bởi A sê -ripqputlinecuộc gọi theo sau làPQENDCOPY, sau đó trở 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ách đọc kèo bóng đá lệnh sẽ được được thực hiện chính xác.

cách đọc kèo bóng đá ứng dụng cũ có khả năng gửi ACopyViaPQEXECvà 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 lệnh sợi dây.