1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>Npgsql</name>
- </assembly>
- <members>
- <member name="T:Npgsql.BackendMessages.CopyDataMessage">
- <summary>
- Note that this message doesn't actually contain the data, but only the length. Data is processed
- directly from the connector's buffer.
- </summary>
- </member>
- <member name="T:Npgsql.BackendMessages.DataRowMessage">
- <summary>
- DataRow is special in that it does not parse the actual contents of the backend message,
- because in sequential mode the message will be traversed and processed sequentially by
- <see cref="T:Npgsql.NpgsqlDataReader"/>.
- </summary>
- </member>
- <member name="T:Npgsql.BackendMessages.ErrorOrNoticeMessage.ErrorFieldTypeCode">
- <summary>
- Error and notice message field codes
- </summary>
- </member>
- <member name="T:Npgsql.BackendMessages.RowDescriptionMessage">
- <summary>
- A RowDescription message sent from the backend.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/protocol-message-formats.html
- </remarks>
- </member>
- <member name="M:Npgsql.BackendMessages.RowDescriptionMessage.GetFieldIndex(System.String)">
- <summary>
- Given a string name, returns the field's ordinal index in the row.
- </summary>
- </member>
- <member name="M:Npgsql.BackendMessages.RowDescriptionMessage.TryGetFieldIndex(System.String,System.Int32@)">
- <summary>
- Given a string name, returns the field's ordinal index in the row.
- </summary>
- </member>
- <member name="T:Npgsql.BackendMessages.RowDescriptionMessage.InsensitiveComparer">
- <summary>
- Comparer that's case-insensitive and Kana width-insensitive
- </summary>
- </member>
- <member name="T:Npgsql.BackendMessages.FieldDescription">
- <summary>
- A descriptive record on a single field received from PostgreSQL.
- See RowDescription in https://www.postgresql.org/docs/current/static/protocol-message-formats.html
- </summary>
- </member>
- <member name="P:Npgsql.BackendMessages.FieldDescription.Name">
- <summary>
- The field name.
- </summary>
- </member>
- <member name="P:Npgsql.BackendMessages.FieldDescription.TypeOID">
- <summary>
- The object ID of the field's data type.
- </summary>
- </member>
- <member name="P:Npgsql.BackendMessages.FieldDescription.TypeSize">
- <summary>
- The data type size (see pg_type.typlen). Note that negative values denote variable-width types.
- </summary>
- </member>
- <member name="P:Npgsql.BackendMessages.FieldDescription.TypeModifier">
- <summary>
- The type modifier (see pg_attribute.atttypmod). The meaning of the modifier is type-specific.
- </summary>
- </member>
- <member name="P:Npgsql.BackendMessages.FieldDescription.TableOID">
- <summary>
- If the field can be identified as a column of a specific table, the object ID of the table; otherwise zero.
- </summary>
- </member>
- <member name="P:Npgsql.BackendMessages.FieldDescription.ColumnAttributeNumber">
- <summary>
- If the field can be identified as a column of a specific table, the attribute number of the column; otherwise zero.
- </summary>
- </member>
- <member name="P:Npgsql.BackendMessages.FieldDescription.FormatCode">
- <summary>
- The format code being used for the field.
- Currently will be zero (text) or one (binary).
- In a RowDescription returned from the statement variant of Describe, the format code is not yet known and will always be zero.
- </summary>
- </member>
- <member name="P:Npgsql.BackendMessages.FieldDescription.Handler">
- <summary>
- The Npgsql type handler assigned to handle this field.
- Returns <see cref="T:Npgsql.Internal.TypeHandlers.UnknownTypeHandler"/> for fields with format text.
- </summary>
- </member>
- <member name="M:Npgsql.BackendMessages.FieldDescription.ToString">
- <summary>
- Returns a string that represents the current object.
- </summary>
- </member>
- <member name="T:Npgsql.IBackendMessage">
- <summary>
- Base class for all classes which represent a message sent by the PostgreSQL backend.
- </summary>
- </member>
- <member name="T:Npgsql.StatementType">
- <summary>
- Specifies the type of SQL statement, e.g. SELECT
- </summary>
- </member>
- <member name="F:Npgsql.ConnectorPool.Connectors">
- <summary>
- Tracks all connectors currently managed by this pool, whether idle or busy.
- Only updated rarely - when physical connections are opened/closed - but is read in perf-sensitive contexts.
- </summary>
- </member>
- <member name="F:Npgsql.ConnectorPool._idleConnectorReader">
- <summary>
- Reader side for the idle connector channel. Contains nulls in order to release waiting attempts after
- a connector has been physically closed/broken.
- </summary>
- </member>
- <member name="F:Npgsql.ConnectorPool._clearCounter">
- <summary>
- Incremented every time this pool is cleared via <see cref="M:Npgsql.NpgsqlConnection.ClearPool(Npgsql.NpgsqlConnection)"/> or
- <see cref="M:Npgsql.NpgsqlConnection.ClearAllPools"/>. Allows us to identify connections which were
- created before the clear.
- </summary>
- </member>
- <member name="P:Npgsql.ConnectorSource.UserFacingConnectionString">
- <summary>
- Contains the connection string returned to the user from <see cref="P:Npgsql.NpgsqlConnection.ConnectionString"/>
- after the connection has been opened. Does not contain the password unless Persist Security Info=true.
- </summary>
- </member>
- <member name="T:Npgsql.Internal.ClusterStateCache">
- <summary>
- Cache for cluster's state
- </summary>
- </member>
- <member name="M:Npgsql.Internal.ClusterStateCache.RemoveClusterState(System.String,System.Int32)">
- <summary>
- Removes the specified cluster's state from cache
- </summary>
- <param name="host">Host address</param>
- <param name="port">Host port</param>
- </member>
- <member name="M:Npgsql.Internal.ClusterStateCache.Clear">
- <summary>
- Removes every cluster's state from cache
- </summary>
- </member>
- <member name="T:Npgsql.Internal.INpgsqlDatabaseInfoFactory">
- <summary>
- A factory which get generate instances of <see cref="T:Npgsql.Internal.NpgsqlDatabaseInfo"/>, which describe a database
- and the types it contains. When first connecting to a database, Npgsql will attempt to load information
- about it via this factory.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.INpgsqlDatabaseInfoFactory.Load(Npgsql.Internal.NpgsqlConnector,Npgsql.Util.NpgsqlTimeout,System.Boolean)">
- <summary>
- Given a connection, loads all necessary information about the connected database, e.g. its types.
- A factory should only handle the exact database type it was meant for, and return null otherwise.
- </summary>
- <returns>
- An object describing the database to which <paramref name="conn"/> is connected, or null if the
- database isn't of the correct type and isn't handled by this factory.
- </returns>
- </member>
- <member name="T:Npgsql.Internal.NpgsqlConnector">
- <summary>
- Represents a connection to a PostgreSQL backend. Unlike NpgsqlConnection objects, which are
- exposed to users, connectors are internal to Npgsql and are recycled by the connection pool.
- </summary>
- </member>
- <member name="T:Npgsql.Internal.NpgsqlConnector.GSSPasswordMessageStream">
- <summary>
- This Stream is placed between NegotiateStream and the socket's NetworkStream (or SSLStream). It intercepts
- traffic and performs the following operations:
- * Outgoing messages are framed in PostgreSQL's PasswordMessage, and incoming are stripped of it.
- * NegotiateStream frames payloads with a 5-byte header, which PostgreSQL doesn't understand. This header is
- stripped from outgoing messages and added to incoming ones.
- </summary>
- <remarks>
- See https://referencesource.microsoft.com/#System/net/System/Net/_StreamFramer.cs,16417e735f0e9530,references
- </remarks>
- </member>
- <member name="F:Npgsql.Internal.NpgsqlConnector._socket">
- <summary>
- The physical connection socket to the backend.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.NpgsqlConnector._baseStream">
- <summary>
- The physical connection stream to the backend, without anything on top.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.NpgsqlConnector._stream">
- <summary>
- The physical connection stream to the backend, layered with an SSL/TLS stream if in secure mode.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlConnector.Settings">
- <summary>
- The parsed connection string.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlConnector.RelaxedTextEncoding">
- <summary>
- Same as <see cref="P:Npgsql.Internal.NpgsqlConnector.TextEncoding"/>, except that it does not throw an exception if an invalid char is
- encountered (exception fallback), but rather replaces it with a question mark character (replacement
- fallback).
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlConnector.ReadBuffer">
- <summary>
- Buffer used for reading data.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.NpgsqlConnector._origReadBuffer">
- <summary>
- If we read a data row that's bigger than <see cref="P:Npgsql.Internal.NpgsqlConnector.ReadBuffer"/>, we allocate an oversize buffer.
- The original (smaller) buffer is stored here, and restored when the connection is reset.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlConnector.WriteBuffer">
- <summary>
- Buffer used for writing data.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.NpgsqlConnector._backendSecretKey">
- <summary>
- The secret key of the backend for this connector, used for query cancellation.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlConnector.BackendProcessId">
- <summary>
- The process ID of the backend for this connector.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlConnector.Id">
- <summary>
- A unique ID identifying this connector, used for logging. Currently mapped to BackendProcessId
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlConnector.DatabaseInfo">
- <summary>
- Information about PostgreSQL and PostgreSQL-like databases (e.g. type definitions, capabilities...).
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlConnector.TransactionStatus">
- <summary>
- The current transaction status for this connector.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlConnector.Transaction">
- <summary>
- A transaction object for this connector. Since only one transaction can be in progress at any given time,
- this instance is recycled. To check whether a transaction is currently in progress on this connector,
- see <see cref="P:Npgsql.Internal.NpgsqlConnector.TransactionStatus"/>.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlConnector.Connection">
- <summary>
- The NpgsqlConnection that (currently) owns this connector. Null if the connector isn't
- owned (i.e. idle in the pool)
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlConnector.PendingPrependedResponses">
- <summary>
- The number of messages that were prepended to the current message chain, but not yet sent.
- Note that this only tracks messages which produce a ReadyForQuery message
- </summary>
- </member>
- <member name="F:Npgsql.Internal.NpgsqlConnector.CurrentCopyOperation">
- <summary>
- If the connector is currently in COPY mode, holds a reference to the importer/exporter object.
- Otherwise null.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.NpgsqlConnector.PostgresParameters">
- <summary>
- Holds all run-time parameters received from the backend (via ParameterStatus messages)
- </summary>
- </member>
- <member name="F:Npgsql.Internal.NpgsqlConnector._rawParameters">
- <summary>
- Holds all run-time parameters in raw, binary format for efficient handling without allocations.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.NpgsqlConnector._breakReason">
- <summary>
- If this connector was broken, this contains the exception that caused the break.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.NpgsqlConnector.DatabaseInfoSemaphore">
- <summary>
- Semaphore, used to synchronize DatabaseInfo between multiple connections, so it wouldn't be loaded in parallel.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.NpgsqlConnector.MultiplexAsyncWritingLock">
- <summary>
- <para>
- Used by the pool to indicate that I/O is currently in progress on this connector, so that another write
- isn't started concurrently. Note that since we have only one write loop, this is only ever usedto
- protect against an over-capacity writes into a connector that's currently *asynchronously* writing.
- </para>
- <para>
- It is guaranteed that the currently-executing
- Specifically, reading may occur - and the connector may even be returned to the pool - before this is
- released.
- </para>
- </summary>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlConnector.FlagAsNotWritableForMultiplexing">
- <seealso cref="F:Npgsql.Internal.NpgsqlConnector.MultiplexAsyncWritingLock"/>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlConnector.FlagAsWritableForMultiplexing">
- <seealso cref="F:Npgsql.Internal.NpgsqlConnector.MultiplexAsyncWritingLock"/>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlConnector.UserTimeout">
- <summary>
- The timeout for reading messages that are part of the user's command
- (i.e. which aren't internal prepended commands).
- </summary>
- <remarks>Precision is milliseconds</remarks>
- </member>
- <member name="F:Npgsql.Internal.NpgsqlConnector._userLock">
- <summary>
- A lock that's taken while a user action is in progress, e.g. a command being executed.
- Only used when keepalive is enabled, otherwise null.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlConnector.CancelLock">
- <summary>
- A lock that's taken while a cancellation is being delivered; new queries are blocked until the
- cancellation is delivered. This reduces the chance that a cancellation meant for a previous
- command will accidentally cancel a later one, see #615.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.NpgsqlConnector._currentCommand">
- <summary>
- The command currently being executed by the connector, null otherwise.
- Used only for concurrent use error reporting purposes.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.NpgsqlConnector._connectorSource">
- <summary>
- The connector source (e.g. pool) from where this connector came, and to which it will be returned.
- Note that in multi-host scenarios, this references the host-specific <see cref="T:Npgsql.ConnectorPool"/> rather than the
- <see cref="T:Npgsql.MultiHostConnectorPool"/>,
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlConnector.OpenTimestamp">
- <summary>
- Contains the UTC timestamp when this connector was opened, used to implement
- <see cref="P:Npgsql.NpgsqlConnectionStringBuilder.ConnectionLifetime"/>.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.NpgsqlConnector.MinimumInternalCommandTimeout">
- <summary>
- The minimum timeout that can be set on internal commands such as COMMIT, ROLLBACK.
- </summary>
- <remarks>Precision is seconds</remarks>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlConnector.InternalCommandTimeout">
- <summary>
- The actual command timeout value that gets set on internal commands.
- </summary>
- <remarks>Precision is milliseconds</remarks>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlConnector.State">
- <summary>
- Gets the current state of the connector
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlConnector.IsConnected">
- <summary>
- Returns whether the connector is open, regardless of any task it is currently performing
- </summary>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlConnector.Open(Npgsql.Util.NpgsqlTimeout,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Opens the physical connection to the server.
- </summary>
- <remarks>Usually called by the RequestConnector
- Method of the connection pool manager.</remarks>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlConnector.PrependInternalMessage(System.Byte[],System.Int32)">
- <summary>
- Prepends a message to be sent at the beginning of the next message chain.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlConnector.SkipUntil(Npgsql.BackendMessageCode)">
- <summary>
- Reads backend messages and discards them, stopping only after a message of the given type has
- been seen. Only a sync I/O version of this method exists - in async flows we inline the loop
- rather than calling an additional async method, in order to avoid the overhead.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlConnector.ProcessNewTransactionStatus(Npgsql.Internal.TransactionStatus)">
- <summary>
- Handles a new transaction indicator received on a ReadyForQuery message
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlConnector.IsSecure">
- <summary>
- Returns whether SSL is being used for the connection
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlConnector.IsScram">
- <summary>
- Returns whether SCRAM-SHA256 is being user for the connection
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlConnector.IsScramPlus">
- <summary>
- Returns whether SCRAM-SHA256-PLUS is being user for the connection
- </summary>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlConnector.PerformPostgresCancellation">
- <summary>
- Creates another connector and sends a cancel request through it for this connector. This method never throws, but returns
- whether the cancellation attempt failed.
- </summary>
- <returns>
- <para>
- <see langword="true" /> if the cancellation request was successfully delivered, or if it was skipped because a previous
- request was already sent. <see langword="false"/> if the cancellation request could not be delivered because of an exception
- (the method logs internally).
- </para>
- <para>
- This does not indicate whether the cancellation attempt was successful on the PostgreSQL side - only if the request was
- delivered.
- </para>
- </returns>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlConnector.StartNestedCancellableOperation(System.Threading.CancellationToken,System.Boolean)">
- <summary>
- Starts a new cancellable operation within an ongoing user action. This should only be used if a single user
- action spans several different actions which each has its own cancellation tokens. For example, a command
- execution is a single user action, but spans ExecuteReaderQuery, NextResult, Read and so forth.
- </summary>
- <remarks>
- Only one level of nested operations is supported. It is an error to call this method if it has previously
- been called, and the returned <see cref="T:System.Threading.CancellationTokenRegistration"/> was not disposed.
- </remarks>
- <param name="cancellationToken">
- The cancellation token provided by the user. Callbacks will be registered on this token for executing the
- cancellation, and the token will be included in any thrown <see cref="T:System.OperationCanceledException"/>.
- </param>
- <param name="attemptPgCancellation">
- If <see langword="true" />, PostgreSQL cancellation will be attempted when the user requests cancellation or
- a timeout occurs, followed by a client-side socket cancellation once
- <see cref="P:Npgsql.NpgsqlConnectionStringBuilder.CancellationTimeout"/> has elapsed. If <see langword="false" />,
- PostgreSQL cancellation will be skipped and client-socket cancellation will occur immediately.
- </param>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlConnector.CloseOngoingOperations(System.Boolean)">
- <summary>
- Closes ongoing operations, i.e. an open reader exists or a COPY operation still in progress, as
- part of a connection close.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlConnector.Dispose">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.NpgsqlConnector.UnexpectedMessageReceived(Npgsql.BackendMessageCode)">
- <summary>
- Called when an unexpected message has been received during an action. Breaks the
- connector and returns the appropriate message.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlConnector.Break(System.Exception)">
- <summary>
- Called when a connector becomes completely unusable, e.g. when an unexpected I/O exception is raised or when
- we lose protocol sync.
- Note that fatal errors during the Open phase do *not* pass through here.
- </summary>
- <param name="reason">The exception that caused the break.</param>
- <returns>The exception given in <paramref name="reason"/> for chaining calls.</returns>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlConnector.Cleanup">
- <summary>
- Closes the socket and cleans up client-side resources associated with this connector.
- </summary>
- <remarks>
- This method doesn't actually perform any meaningful I/O, and therefore is sync-only.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlConnector.Reset(System.Boolean)">
- <summary>
- Called when a pooled connection is closed, and its connector is returned to the pool.
- Resets the connector back to its initial state, releasing server-side sources
- (e.g. prepared statements), resetting parameters to their defaults, and resetting client-side
- state
- </summary>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlConnector.ResetReadBuffer">
- <summary>
- The connector may have allocated an oversize read buffer, to hold big rows in non-sequential reading.
- This switches us back to the original one and returns the buffer to <see cref="T:System.Buffers.ArrayPool`1" />.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlConnector.StartUserAction(Npgsql.Internal.ConnectorState,Npgsql.NpgsqlCommand,System.Threading.CancellationToken,System.Boolean)">
- <summary>
- Starts a user action. This makes sure that another action isn't already in progress, handles synchronization with keepalive,
- and sets up cancellation.
- </summary>
- <param name="newState">The new state to be set when entering this user action.</param>
- <param name="command">
- The <see cref="T:Npgsql.NpgsqlCommand" /> that is starting execution - if an <see cref="T:Npgsql.NpgsqlOperationInProgressException" /> is
- thrown, it will reference this.
- </param>
- <param name="cancellationToken">
- The cancellation token provided by the user. Callbacks will be registered on this token for executing the cancellation,
- and the token will be included in any thrown <see cref="T:System.OperationCanceledException"/>.
- </param>
- <param name="attemptPgCancellation">
- If <see langword="true" />, PostgreSQL cancellation will be attempted when the user requests cancellation or a timeout
- occurs, followed by a client-side socket cancellation once <see cref="P:Npgsql.NpgsqlConnectionStringBuilder.CancellationTimeout"/> has
- elapsed. If <see langword="false" />, PostgreSQL cancellation will be skipped and client-socket cancellation will occur
- immediately.
- </param>
- </member>
- <member name="T:Npgsql.Internal.NpgsqlConnector.UserAction">
- <summary>
- An IDisposable wrapper around <see cref="M:Npgsql.Internal.NpgsqlConnector.EndUserAction"/>.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlConnector.Timezone">
- <summary>
- The connection's timezone as reported by PostgreSQL, in the IANA/Olson database format.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlConnector.CreateCommand(System.String)">
- <summary>
- Creates and returns a <see cref="T:Npgsql.NpgsqlCommand"/> object associated with the <see cref="T:Npgsql.Internal.NpgsqlConnector"/>.
- </summary>
- <param name="cmdText">The text of the query.</param>
- <returns>A <see cref="T:Npgsql.NpgsqlCommand"/> object.</returns>
- </member>
- <member name="T:Npgsql.Internal.ConnectorState">
- <summary>
- Expresses the exact state of a connector.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.ConnectorState.Closed">
- <summary>
- The connector has either not yet been opened or has been closed.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.ConnectorState.Connecting">
- <summary>
- The connector is currently connecting to a PostgreSQL server.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.ConnectorState.Ready">
- <summary>
- The connector is connected and may be used to send a new query.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.ConnectorState.Executing">
- <summary>
- The connector is waiting for a response to a query which has been sent to the server.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.ConnectorState.Fetching">
- <summary>
- The connector is currently fetching and processing query results.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.ConnectorState.Waiting">
- <summary>
- The connector is currently waiting for asynchronous notifications to arrive.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.ConnectorState.Broken">
- <summary>
- The connection was broken because an unexpected error occurred which left it in an unknown state.
- This state isn't implemented yet.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.ConnectorState.Copy">
- <summary>
- The connector is engaged in a COPY operation.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.ConnectorState.Replication">
- <summary>
- The connector is engaged in streaming replication.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.TransactionStatus.Idle">
- <summary>
- Currently not in a transaction block
- </summary>
- </member>
- <member name="F:Npgsql.Internal.TransactionStatus.InTransactionBlock">
- <summary>
- Currently in a transaction block
- </summary>
- </member>
- <member name="F:Npgsql.Internal.TransactionStatus.InFailedTransactionBlock">
- <summary>
- Currently in a failed transaction block (queries will be rejected until block is ended)
- </summary>
- </member>
- <member name="F:Npgsql.Internal.TransactionStatus.Pending">
- <summary>
- A new transaction has been requested but not yet transmitted to the backend. It will be transmitted
- prepended to the next query.
- This is a client-side state option only, and is never transmitted from the backend.
- </summary>
- </member>
- <member name="T:Npgsql.Internal.DataRowLoadingMode">
- <summary>
- Specifies how to load/parse DataRow messages as they're received from the backend.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.DataRowLoadingMode.NonSequential">
- <summary>
- Load DataRows in non-sequential mode
- </summary>
- </member>
- <member name="F:Npgsql.Internal.DataRowLoadingMode.Sequential">
- <summary>
- Load DataRows in sequential mode
- </summary>
- </member>
- <member name="F:Npgsql.Internal.DataRowLoadingMode.Skip">
- <summary>
- Skip DataRow messages altogether
- </summary>
- </member>
- <member name="T:Npgsql.Internal.NpgsqlDatabaseInfo">
- <summary>
- Base class for implementations which provide information about PostgreSQL and PostgreSQL-like databases
- (e.g. type definitions, capabilities...).
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlDatabaseInfo.Host">
- <summary>
- The hostname of IP address of the database.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlDatabaseInfo.Port">
- <summary>
- The TCP port of the database.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlDatabaseInfo.Name">
- <summary>
- The database name.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlDatabaseInfo.Version">
- <summary>
- The version of the PostgreSQL database we're connected to, as reported in the "server_version" parameter.
- Exposed via <see cref="P:Npgsql.NpgsqlConnection.PostgreSqlVersion"/>.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlDatabaseInfo.ServerVersion">
- <summary>
- The PostgreSQL version string as returned by the server_version option. Populated during loading.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlDatabaseInfo.SupportsRangeTypes">
- <summary>
- Whether the backend supports range types.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlDatabaseInfo.SupportsMultirangeTypes">
- <summary>
- Whether the backend supports multirange types.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlDatabaseInfo.SupportsEnumTypes">
- <summary>
- Whether the backend supports enum types.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlDatabaseInfo.SupportsCloseAll">
- <summary>
- Whether the backend supports the CLOSE ALL statement.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlDatabaseInfo.SupportsAdvisoryLocks">
- <summary>
- Whether the backend supports advisory locks.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlDatabaseInfo.SupportsDiscardSequences">
- <summary>
- Whether the backend supports the DISCARD SEQUENCES statement.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlDatabaseInfo.SupportsUnlisten">
- <summary>
- Whether the backend supports the UNLISTEN statement.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlDatabaseInfo.SupportsDiscardTemp">
- <summary>
- Whether the backend supports the DISCARD TEMP statement.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlDatabaseInfo.SupportsDiscard">
- <summary>
- Whether the backend supports the DISCARD statement.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlDatabaseInfo.HasIntegerDateTimes">
- <summary>
- Reports whether the backend uses the newer integer timestamp representation.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlDatabaseInfo.SupportsTransactions">
- <summary>
- Whether the database supports transactions.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlDatabaseInfo.ByOID">
- <summary>
- Indexes backend types by their type OID.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlDatabaseInfo.ByFullName">
- <summary>
- Indexes backend types by their PostgreSQL name, including namespace (e.g. pg_catalog.int4).
- Only used for enums and composites.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlDatabaseInfo.ByName">
- <summary>
- Indexes backend types by their PostgreSQL name, not including namespace.
- If more than one type exists with the same name (i.e. in different namespaces) this
- table will contain an entry with a null value.
- Only used for enums and composites.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlDatabaseInfo.#ctor(System.String,System.Int32,System.String,System.Version)">
- <summary>
- Initializes the instance of <see cref="T:Npgsql.Internal.NpgsqlDatabaseInfo"/>.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlDatabaseInfo.#ctor(System.String,System.Int32,System.String,System.Version,System.String)">
- <summary>
- Initializes the instance of <see cref="T:Npgsql.Internal.NpgsqlDatabaseInfo"/>.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlDatabaseInfo.GetTypes">
- <summary>
- Provides all PostgreSQL types detected in this database.
- </summary>
- <returns></returns>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlDatabaseInfo.ParseServerVersion(System.String)">
- <summary>
- Parses a PostgreSQL server version (e.g. 10.1, 9.6.3) and returns a CLR Version.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlDatabaseInfo.RegisterFactory(Npgsql.Internal.INpgsqlDatabaseInfoFactory)">
- <summary>
- Registers a new database info factory, which is used to load information about databases.
- </summary>
- </member>
- <member name="T:Npgsql.Internal.NpgsqlReadBuffer">
- <summary>
- A buffer used by Npgsql to read data from the socket efficiently.
- Provides methods which decode different values types and tracks the current position.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlReadBuffer.Timeout">
- <summary>
- Timeout for sync and async reads
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlReadBuffer.Size">
- <summary>
- The total byte length of the buffer.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlReadBuffer.RelaxedTextEncoding">
- <summary>
- Same as <see cref="P:Npgsql.Internal.NpgsqlReadBuffer.TextEncoding"/>, except that it does not throw an exception if an invalid char is
- encountered (exception fallback), but rather replaces it with a question mark character (replacement
- fallback).
- </summary>
- </member>
- <member name="F:Npgsql.Internal.NpgsqlReadBuffer.MinimumSize">
- <summary>
- The minimum buffer size possible.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlReadBuffer.Ensure(System.Int32,System.Boolean,System.Boolean)">
- <summary>
- Ensures that <paramref name="count"/> bytes are available in the buffer, and if
- not, reads from the socket until enough is available.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlReadBuffer.Skip(System.Int64)">
- <summary>
- Does not perform any I/O - assuming that the bytes to be skipped are in the memory buffer.
- </summary>
- <param name="len"></param>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlReadBuffer.Skip(System.Int64,System.Boolean)">
- <summary>
- Skip a given number of bytes.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlReadBuffer.ReadNullTerminatedString">
- <summary>
- Seeks the first null terminator (\0) and returns the string up to it. The buffer must already
- contain the entire string and its terminator.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlReadBuffer.ReadNullTerminatedStringRelaxed">
- <summary>
- Seeks the first null terminator (\0) and returns the string up to it. The buffer must already
- contain the entire string and its terminator. If any character could not be decoded, a question
- mark character is returned instead of throwing an exception.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlReadBuffer.ReadNullTerminatedString(System.Text.Encoding,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Seeks the first null terminator (\0) and returns the string up to it. Reads additional data from the network if a null
- terminator isn't found in the buffered data.
- </summary>
- </member>
- <member name="T:Npgsql.Internal.NpgsqlWriteBuffer">
- <summary>
- A buffer used by Npgsql to write data to the socket efficiently.
- Provides methods which encode different values types and tracks the current position.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlWriteBuffer.Timeout">
- <summary>
- Timeout for sync and async writes
- </summary>
- </member>
- <member name="P:Npgsql.Internal.NpgsqlWriteBuffer.Size">
- <summary>
- The total byte length of the buffer.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.NpgsqlWriteBuffer.MinimumSize">
- <summary>
- The minimum buffer size possible.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.NpgsqlWriteBuffer.GetContents">
- <summary>
- Returns all contents currently written to the buffer (but not flushed).
- Useful for pre-generating messages.
- </summary>
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.ArrayHandler">
- <summary>
- Non-generic base class for all type handlers which handle PostgreSQL arrays.
- Extend from <see cref="T:Npgsql.Internal.TypeHandlers.ArrayHandler`1"/> instead.
- </summary>
- <remarks>
- https://www.postgresql.org/docs/current/static/arrays.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.ArrayHandler.#ctor(Npgsql.PostgresTypes.PostgresType,Npgsql.Internal.TypeHandling.NpgsqlTypeHandler,Npgsql.ArrayNullabilityMode,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.ArrayHandler.CreateArrayHandler(Npgsql.PostgresTypes.PostgresArrayType,Npgsql.ArrayNullabilityMode)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.ArrayHandler.CreateRangeHandler(Npgsql.PostgresTypes.PostgresType)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.ArrayHandler.CreateMultirangeHandler(Npgsql.PostgresTypes.PostgresMultirangeType)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.ArrayHandler.ReadCustom``1(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.ArrayHandler.ReadArray``1(Npgsql.Internal.NpgsqlReadBuffer,System.Boolean,System.Int32,System.Boolean)">
- <summary>
- Reads an array of element type <typeparamref name="TRequestedElement"/> from the given buffer <paramref name="buf"/>.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.ArrayHandler.ReadList``1(Npgsql.Internal.NpgsqlReadBuffer,System.Boolean)">
- <summary>
- Reads a generic list containing elements of type <typeparamref name="TRequestedElement"/> from the given buffer <paramref name="buf"/>.
- </summary>
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.ArrayHandler`1">
- <summary>
- Base class for all type handlers which handle PostgreSQL arrays.
- </summary>
- <remarks>
- https://www.postgresql.org/docs/current/static/arrays.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.ArrayHandler`1.#ctor(Npgsql.PostgresTypes.PostgresType,Npgsql.Internal.TypeHandling.NpgsqlTypeHandler,Npgsql.ArrayNullabilityMode,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.ArrayHandler`1.ValidateAndGetLengthCustom``1(``0,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.ArrayHandler`1.ValidateObjectAndGetLength(System.Object,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.ArrayHandler`1.WriteObjectWithLength(System.Object,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.ArrayHandlerWithPsv`2">
- <remarks>
- https://www.postgresql.org/docs/current/static/arrays.html
- </remarks>
- <typeparam name="TElement">The .NET type contained as an element within this array</typeparam>
- <typeparam name="TElementPsv">The .NET provider-specific type contained as an element within this array</typeparam>
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.BitStringHandler">
- <summary>
- A type handler for the PostgreSQL bit string data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-bit.html.
-
- Note that for BIT(1), this handler will return a bool by default, to align with SQLClient
- (see discussion https://github.com/npgsql/npgsql/pull/362#issuecomment-59622101).
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.BitStringHandler.CreateArrayHandler(Npgsql.PostgresTypes.PostgresArrayType,Npgsql.ArrayNullabilityMode)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.BitStringHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.BitStringHandler.ValidateAndGetLength(System.Collections.BitArray,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.BitStringHandler.ValidateAndGetLength(System.Collections.Specialized.BitVector32,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.BitStringHandler.ValidateAndGetLength(System.Boolean,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.BitStringHandler.ValidateAndGetLength(System.String,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.BitStringHandler.Write(System.Collections.BitArray,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.BitStringHandler.Write(System.Collections.Specialized.BitVector32,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.BitStringHandler.Write(System.Boolean,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.BitStringHandler.Write(System.String,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.BitStringArrayHandler">
- <summary>
- A special handler for arrays of bit strings.
- Differs from the standard array handlers in that it returns arrays of bool for BIT(1) and arrays
- of BitArray otherwise (just like the scalar BitStringHandler does).
- </summary>
- <remarks>
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.BitStringArrayHandler.#ctor(Npgsql.PostgresTypes.PostgresType,Npgsql.Internal.TypeHandlers.BitStringHandler,Npgsql.ArrayNullabilityMode)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.BitStringArrayHandler.ReadCustom``1(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.BoolHandler">
- <summary>
- A type handler for the PostgreSQL bool data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-boolean.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.BoolHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.BoolHandler.ValidateAndGetLength(System.Boolean,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.BoolHandler.Write(System.Boolean,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.ByteaHandler">
- <summary>
- A type handler for the PostgreSQL bytea data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-binary.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.ByteaHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.ByteaHandler.ValidateAndGetLength(System.Byte[],Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.ByteaHandler.ValidateAndGetLength(System.ArraySegment{System.Byte},Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.ByteaHandler.Write(System.Byte[],Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.ByteaHandler.Write(System.ArraySegment{System.Byte},Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.ByteaHandler.ValidateAndGetLength(System.Memory{System.Byte},Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.ByteaHandler.ValidateAndGetLength(System.ReadOnlyMemory{System.Byte},Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.ByteaHandler.Write(System.ReadOnlyMemory{System.Byte},Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.ByteaHandler.Write(System.Memory{System.Byte},Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.Internal.TypeHandlers.CompositeHandlers.ICompositeHandler.CompositeType">
- <summary>
- The CLR type mapped to the PostgreSQL composite type.
- </summary>
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.DateTimeHandlers.DateHandler">
- <summary>
- A type handler for the PostgreSQL date data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-datetime.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.DateHandler.#ctor(Npgsql.PostgresTypes.PostgresType)">
- <summary>
- Constructs a <see cref="T:Npgsql.Internal.TypeHandlers.DateTimeHandlers.DateHandler"/>
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.DateHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.DateHandler.ReadPsv(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <remarks>
- Copied wholesale from Postgresql backend/utils/adt/datetime.c:j2date
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.DateHandler.ValidateAndGetLength(System.DateTime,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.DateHandler.ValidateAndGetLength(NpgsqlTypes.NpgsqlDate,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.DateHandler.ValidateAndGetLength(System.Int32,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.DateHandler.Write(System.DateTime,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.DateHandler.Write(NpgsqlTypes.NpgsqlDate,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.DateHandler.Write(System.Int32,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.DateTimeHandlers.IntervalHandler">
- <summary>
- A type handler for the PostgreSQL date interval type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-datetime.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.IntervalHandler.#ctor(Npgsql.PostgresTypes.PostgresType)">
- <summary>
- Constructs an <see cref="T:Npgsql.Internal.TypeHandlers.DateTimeHandlers.IntervalHandler"/>
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.IntervalHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.IntervalHandler.ReadPsv(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.IntervalHandler.ValidateAndGetLength(System.TimeSpan,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.IntervalHandler.ValidateAndGetLength(NpgsqlTypes.NpgsqlTimeSpan,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.IntervalHandler.ValidateAndGetLength(NpgsqlTypes.NpgsqlInterval,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.IntervalHandler.Write(NpgsqlTypes.NpgsqlTimeSpan,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.IntervalHandler.Write(System.TimeSpan,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimeHandler">
- <summary>
- A type handler for the PostgreSQL time data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-datetime.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimeHandler.#ctor(Npgsql.PostgresTypes.PostgresType)">
- <summary>
- Constructs a <see cref="T:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimeHandler"/>.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimeHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimeHandler.ValidateAndGetLength(System.TimeSpan,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimeHandler.Write(System.TimeSpan,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampHandler">
- <summary>
- A type handler for the PostgreSQL timestamp data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-datetime.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampHandler.#ctor(Npgsql.PostgresTypes.PostgresType)">
- <summary>
- Constructs a <see cref="T:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampHandler"/>.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampHandler.ReadPsv(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampHandler.ValidateAndGetLength(System.DateTime,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampHandler.ValidateAndGetLength(NpgsqlTypes.NpgsqlDateTime,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampHandler.ValidateAndGetLength(System.Int64,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampHandler.Write(System.DateTime,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampHandler.Write(NpgsqlTypes.NpgsqlDateTime,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampHandler.Write(System.Int64,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampTzHandler">
- <summary>
- A type handler for the PostgreSQL timestamptz data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-datetime.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampTzHandler.#ctor(Npgsql.PostgresTypes.PostgresType)">
- <summary>
- Constructs an <see cref="T:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampTzHandler"/>.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampTzHandler.CreateRangeHandler(Npgsql.PostgresTypes.PostgresType)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampTzHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampTzHandler.ReadPsv(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampTzHandler.ValidateAndGetLength(System.DateTime,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampTzHandler.ValidateAndGetLength(NpgsqlTypes.NpgsqlDateTime,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampTzHandler.ValidateAndGetLength(System.DateTimeOffset,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampTzHandler.ValidateAndGetLength(System.Int64,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampTzHandler.Write(System.DateTime,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampTzHandler.Write(NpgsqlTypes.NpgsqlDateTime,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampTzHandler.Write(System.DateTimeOffset,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimestampTzHandler.Write(System.Int64,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimeTzHandler">
- <summary>
- A type handler for the PostgreSQL timetz data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-datetime.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimeTzHandler.#ctor(Npgsql.PostgresTypes.PostgresType)">
- <summary>
- Constructs an <see cref="T:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimeTzHandler"/>.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimeTzHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimeTzHandler.ValidateAndGetLength(System.DateTimeOffset,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.DateTimeHandlers.TimeTzHandler.Write(System.DateTimeOffset,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.IEnumHandler">
- <summary>
- Interface implemented by all concrete handlers which handle enums
- </summary>
- </member>
- <member name="P:Npgsql.Internal.TypeHandlers.IEnumHandler.EnumType">
- <summary>
- The CLR enum type mapped to the PostgreSQL enum
- </summary>
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.FullTextSearchHandlers.TsQueryHandler">
- <summary>
- A type handler for the PostgreSQL tsquery data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-textsearch.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.FullTextSearchHandlers.TsQueryHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.FullTextSearchHandlers.TsQueryHandler.ValidateAndGetLength(NpgsqlTypes.NpgsqlTsQuery,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.FullTextSearchHandlers.TsQueryHandler.Write(NpgsqlTypes.NpgsqlTsQuery,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.FullTextSearchHandlers.TsQueryHandler.ValidateAndGetLength(NpgsqlTypes.NpgsqlTsQueryOr,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.FullTextSearchHandlers.TsQueryHandler.ValidateAndGetLength(NpgsqlTypes.NpgsqlTsQueryAnd,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.FullTextSearchHandlers.TsQueryHandler.ValidateAndGetLength(NpgsqlTypes.NpgsqlTsQueryNot,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.FullTextSearchHandlers.TsQueryHandler.ValidateAndGetLength(NpgsqlTypes.NpgsqlTsQueryLexeme,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.FullTextSearchHandlers.TsQueryHandler.ValidateAndGetLength(NpgsqlTypes.NpgsqlTsQueryEmpty,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.FullTextSearchHandlers.TsQueryHandler.ValidateAndGetLength(NpgsqlTypes.NpgsqlTsQueryFollowedBy,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.FullTextSearchHandlers.TsQueryHandler.Write(NpgsqlTypes.NpgsqlTsQueryOr,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.FullTextSearchHandlers.TsQueryHandler.Write(NpgsqlTypes.NpgsqlTsQueryAnd,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.FullTextSearchHandlers.TsQueryHandler.Write(NpgsqlTypes.NpgsqlTsQueryNot,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.FullTextSearchHandlers.TsQueryHandler.Write(NpgsqlTypes.NpgsqlTsQueryLexeme,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.FullTextSearchHandlers.TsQueryHandler.Write(NpgsqlTypes.NpgsqlTsQueryEmpty,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.FullTextSearchHandlers.TsQueryHandler.Write(NpgsqlTypes.NpgsqlTsQueryFollowedBy,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.FullTextSearchHandlers.TsVectorHandler">
- <summary>
- A type handler for the PostgreSQL tsvector data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-textsearch.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.FullTextSearchHandlers.TsVectorHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.FullTextSearchHandlers.TsVectorHandler.ValidateAndGetLength(NpgsqlTypes.NpgsqlTsVector,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.FullTextSearchHandlers.TsVectorHandler.Write(NpgsqlTypes.NpgsqlTsVector,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.GeometricHandlers.BoxHandler">
- <summary>
- A type handler for the PostgreSQL box data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-geometric.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.GeometricHandlers.BoxHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.GeometricHandlers.BoxHandler.ValidateAndGetLength(NpgsqlTypes.NpgsqlBox,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.GeometricHandlers.BoxHandler.Write(NpgsqlTypes.NpgsqlBox,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.GeometricHandlers.CircleHandler">
- <summary>
- A type handler for the PostgreSQL circle data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-geometric.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.GeometricHandlers.CircleHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.GeometricHandlers.CircleHandler.ValidateAndGetLength(NpgsqlTypes.NpgsqlCircle,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.GeometricHandlers.CircleHandler.Write(NpgsqlTypes.NpgsqlCircle,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.GeometricHandlers.LineHandler">
- <summary>
- A type handler for the PostgreSQL line data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-geometric.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.GeometricHandlers.LineHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.GeometricHandlers.LineHandler.ValidateAndGetLength(NpgsqlTypes.NpgsqlLine,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.GeometricHandlers.LineHandler.Write(NpgsqlTypes.NpgsqlLine,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.GeometricHandlers.LineSegmentHandler">
- <summary>
- A type handler for the PostgreSQL lseg data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-geometric.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.GeometricHandlers.LineSegmentHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.GeometricHandlers.LineSegmentHandler.ValidateAndGetLength(NpgsqlTypes.NpgsqlLSeg,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.GeometricHandlers.LineSegmentHandler.Write(NpgsqlTypes.NpgsqlLSeg,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.GeometricHandlers.PathHandler">
- <summary>
- A type handler for the PostgreSQL path data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-geometric.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.GeometricHandlers.PathHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.GeometricHandlers.PathHandler.ValidateAndGetLength(NpgsqlTypes.NpgsqlPath,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.GeometricHandlers.PathHandler.Write(NpgsqlTypes.NpgsqlPath,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.GeometricHandlers.PointHandler">
- <summary>
- A type handler for the PostgreSQL point data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-geometric.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.GeometricHandlers.PointHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.GeometricHandlers.PointHandler.ValidateAndGetLength(NpgsqlTypes.NpgsqlPoint,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.GeometricHandlers.PointHandler.Write(NpgsqlTypes.NpgsqlPoint,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.GeometricHandlers.PolygonHandler">
- <summary>
- A type handler for the PostgreSQL polygon data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-geometric.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.GeometricHandlers.PolygonHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.GeometricHandlers.PolygonHandler.ValidateAndGetLength(NpgsqlTypes.NpgsqlPolygon,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.GeometricHandlers.PolygonHandler.Write(NpgsqlTypes.NpgsqlPolygon,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.HstoreHandler">
- <summary>
- A type handler for the PostgreSQL hstore extension data type, which stores sets of key/value pairs within a
- single PostgreSQL value.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/hstore.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="F:Npgsql.Internal.TypeHandlers.HstoreHandler._textHandler">
- <summary>
- The text handler to which we delegate encoding/decoding of the actual strings
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.HstoreHandler.ValidateAndGetLength(System.Collections.Generic.IDictionary{System.String,System.String},Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.HstoreHandler.ValidateAndGetLength(System.Collections.Generic.Dictionary{System.String,System.String},Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.HstoreHandler.ValidateObjectAndGetLength(System.Object,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.HstoreHandler.WriteObjectWithLength(System.Object,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.HstoreHandler.Write(System.Collections.Generic.IDictionary{System.String,System.String},Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.HstoreHandler.Write(System.Collections.Generic.Dictionary{System.String,System.String},Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.HstoreHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.HstoreHandler.ValidateAndGetLength(System.Collections.Immutable.ImmutableDictionary{System.String,System.String},Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.HstoreHandler.Write(System.Collections.Immutable.ImmutableDictionary{System.String,System.String},Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.InternalTypeHandlers.Int2VectorHandler">
- <summary>
- An int2vector is simply a regular array of shorts, with the sole exception that its lower bound must
- be 0 (we send 1 for regular arrays).
- </summary>
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.InternalTypeHandlers.InternalCharHandler">
- <summary>
- A type handler for the PostgreSQL "char" type, used only internally.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-character.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.InternalTypeHandlers.InternalCharHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.InternalTypeHandlers.InternalCharHandler.ValidateAndGetLength(System.Byte,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.InternalTypeHandlers.InternalCharHandler.ValidateAndGetLength(System.Char,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.InternalTypeHandlers.InternalCharHandler.ValidateAndGetLength(System.Int16,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.InternalTypeHandlers.InternalCharHandler.ValidateAndGetLength(System.Int32,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.InternalTypeHandlers.InternalCharHandler.ValidateAndGetLength(System.Int64,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.InternalTypeHandlers.InternalCharHandler.Write(System.Char,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.InternalTypeHandlers.InternalCharHandler.Write(System.Byte,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.InternalTypeHandlers.InternalCharHandler.Write(System.Int16,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.InternalTypeHandlers.InternalCharHandler.Write(System.Int32,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.InternalTypeHandlers.InternalCharHandler.Write(System.Int64,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.InternalTypeHandlers.OIDVectorHandler">
- <summary>
- An OIDVector is simply a regular array of uints, with the sole exception that its lower bound must
- be 0 (we send 1 for regular arrays).
- </summary>
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.JsonHandler">
- <summary>
- A type handler for the PostgreSQL json and jsonb data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/datatype-json.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="F:Npgsql.Internal.TypeHandlers.JsonHandler.JsonbProtocolVersion">
- <summary>
- Prepended to the string in the wire encoding
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.JsonHandler.#ctor(Npgsql.PostgresTypes.PostgresType,System.Text.Encoding,System.Boolean,System.Text.Json.JsonSerializerOptions)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.JsonHandler.ValidateAndGetLengthCustom``1(``0,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.JsonHandler.WriteWithLengthCustom``1(``0,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.JsonHandler.ValidateAndGetLength(System.String,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.JsonHandler.Write(System.String,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.JsonHandler.ValidateObjectAndGetLength(System.Object,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.JsonHandler.WriteObjectWithLength(System.Object,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.JsonHandler.ReadCustom``1(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.JsonHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.JsonHandler.GetTextReader(System.IO.Stream)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.JsonPathHandler">
- <summary>
- A type handler for the PostgreSQL jsonpath data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/datatype-json.html#DATATYPE-JSONPATH.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="F:Npgsql.Internal.TypeHandlers.JsonPathHandler.JsonPathVersion">
- <summary>
- Prepended to the string in the wire encoding
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.JsonPathHandler.#ctor(Npgsql.PostgresTypes.PostgresType,System.Text.Encoding)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.JsonPathHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.JsonPathHandler.ValidateAndGetLength(System.String,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.JsonPathHandler.Write(System.String,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.JsonPathHandler.GetTextReader(System.IO.Stream)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.LTreeHandlers.LQueryHandler">
- <summary>
- LQuery binary encoding is a simple UTF8 string, but prepended with a version number.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.TypeHandlers.LTreeHandlers.LQueryHandler.LQueryProtocolVersion">
- <summary>
- Prepended to the string in the wire encoding
- </summary>
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.LTreeHandlers.LTreeHandler">
- <summary>
- Ltree binary encoding is a simple UTF8 string, but prepended with a version number.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.TypeHandlers.LTreeHandlers.LTreeHandler.LtreeProtocolVersion">
- <summary>
- Prepended to the string in the wire encoding
- </summary>
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.LTreeHandlers.LTxtQueryHandler">
- <summary>
- LTxtQuery binary encoding is a simple UTF8 string, but prepended with a version number.
- </summary>
- </member>
- <member name="F:Npgsql.Internal.TypeHandlers.LTreeHandlers.LTxtQueryHandler.LTxtQueryProtocolVersion">
- <summary>
- Prepended to the string in the wire encoding
- </summary>
- </member>
- <member name="P:Npgsql.Internal.TypeHandlers.MultirangeHandler`1.RangeHandler">
- <summary>
- The type handler for the range that this multirange type holds
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.MultirangeHandler`1.#ctor(Npgsql.PostgresTypes.PostgresMultirangeType,Npgsql.Internal.TypeHandlers.RangeHandler{`0})">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.MultirangeHandler`2.#ctor(Npgsql.PostgresTypes.PostgresMultirangeType,Npgsql.Internal.TypeHandlers.RangeHandler{`0,`1})">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.NetworkHandlers.CidrHandler">
- <summary>
- A type handler for the PostgreSQL cidr data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-net-types.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NetworkHandlers.CidrHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NetworkHandlers.CidrHandler.ValidateAndGetLength(System.ValueTuple{System.Net.IPAddress,System.Int32},Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NetworkHandlers.CidrHandler.ValidateAndGetLength(NpgsqlTypes.NpgsqlInet,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NetworkHandlers.CidrHandler.Write(System.ValueTuple{System.Net.IPAddress,System.Int32},Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NetworkHandlers.CidrHandler.Write(NpgsqlTypes.NpgsqlInet,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.NetworkHandlers.InetHandler">
- <summary>
- A type handler for the PostgreSQL cidr data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-net-types.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NetworkHandlers.InetHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NetworkHandlers.InetHandler.ReadPsv(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NetworkHandlers.InetHandler.ValidateAndGetLength(System.Net.IPAddress,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NetworkHandlers.InetHandler.ValidateAndGetLength(System.ValueTuple{System.Net.IPAddress,System.Int32},Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NetworkHandlers.InetHandler.ValidateAndGetLength(NpgsqlTypes.NpgsqlInet,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NetworkHandlers.InetHandler.Write(System.Net.IPAddress,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NetworkHandlers.InetHandler.Write(System.ValueTuple{System.Net.IPAddress,System.Int32},Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NetworkHandlers.InetHandler.Write(NpgsqlTypes.NpgsqlInet,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.NetworkHandlers.MacaddrHandler">
- <summary>
- A type handler for the PostgreSQL macaddr and macaddr8 data types.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-net-types.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NetworkHandlers.MacaddrHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NetworkHandlers.MacaddrHandler.ValidateAndGetLength(System.Net.NetworkInformation.PhysicalAddress,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NetworkHandlers.MacaddrHandler.Write(System.Net.NetworkInformation.PhysicalAddress,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.NumericHandlers.DoubleHandler">
- <summary>
- A type handler for the PostgreSQL double precision data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-numeric.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.DoubleHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.DoubleHandler.ValidateAndGetLength(System.Double,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.DoubleHandler.Write(System.Double,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.NumericHandlers.Int16Handler">
- <summary>
- A type handler for the PostgreSQL smallint data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-numeric.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int16Handler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int16Handler.ValidateAndGetLength(System.Int16,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int16Handler.ValidateAndGetLength(System.Byte,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int16Handler.ValidateAndGetLength(System.SByte,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int16Handler.ValidateAndGetLength(System.Decimal,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int16Handler.ValidateAndGetLength(System.Int32,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int16Handler.ValidateAndGetLength(System.Int64,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int16Handler.ValidateAndGetLength(System.Single,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int16Handler.ValidateAndGetLength(System.Double,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int16Handler.Write(System.Int16,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int16Handler.Write(System.Int32,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int16Handler.Write(System.Int64,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int16Handler.Write(System.Byte,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int16Handler.Write(System.SByte,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int16Handler.Write(System.Decimal,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int16Handler.Write(System.Double,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int16Handler.Write(System.Single,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.NumericHandlers.Int32Handler">
- <summary>
- A type handler for the PostgreSQL integer data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-numeric.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int32Handler.ValidateAndGetLength(System.Int32,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int32Handler.ValidateAndGetLength(System.Int16,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int32Handler.ValidateAndGetLength(System.Byte,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int32Handler.ValidateAndGetLength(System.Decimal,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int32Handler.ValidateAndGetLength(System.Int64,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int32Handler.ValidateAndGetLength(System.Single,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int32Handler.ValidateAndGetLength(System.Double,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int32Handler.Write(System.Int32,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int32Handler.Write(System.Int16,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int32Handler.Write(System.Int64,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int32Handler.Write(System.Byte,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int32Handler.Write(System.Single,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int32Handler.Write(System.Double,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int32Handler.Write(System.Decimal,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.NumericHandlers.Int64Handler">
- <summary>
- A type handler for the PostgreSQL bigint data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-numeric.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int64Handler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int64Handler.ValidateAndGetLength(System.Int64,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int64Handler.ValidateAndGetLength(System.Int32,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int64Handler.ValidateAndGetLength(System.Int16,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int64Handler.ValidateAndGetLength(System.Byte,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int64Handler.ValidateAndGetLength(System.Decimal,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int64Handler.ValidateAndGetLength(System.Single,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int64Handler.ValidateAndGetLength(System.Double,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int64Handler.Write(System.Int64,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int64Handler.Write(System.Int16,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int64Handler.Write(System.Int32,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int64Handler.Write(System.Byte,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int64Handler.Write(System.Single,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int64Handler.Write(System.Double,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.Int64Handler.Write(System.Decimal,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.NumericHandlers.MoneyHandler">
- <summary>
- A type handler for the PostgreSQL money data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-money.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.MoneyHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.MoneyHandler.ValidateAndGetLength(System.Decimal,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.MoneyHandler.Write(System.Decimal,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.NumericHandlers.NumericHandler">
- <summary>
- A type handler for the PostgreSQL numeric data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-numeric.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.NumericHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.NumericHandler.ValidateAndGetLength(System.Decimal,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.NumericHandler.ValidateAndGetLength(System.Int16,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.NumericHandler.ValidateAndGetLength(System.Int32,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.NumericHandler.ValidateAndGetLength(System.Int64,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.NumericHandler.ValidateAndGetLength(System.Single,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.NumericHandler.ValidateAndGetLength(System.Double,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.NumericHandler.ValidateAndGetLength(System.Byte,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.NumericHandler.Write(System.Int16,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.NumericHandler.Write(System.Int32,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.NumericHandler.Write(System.Int64,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.NumericHandler.Write(System.Byte,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.NumericHandler.Write(System.Single,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.NumericHandler.Write(System.Double,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.NumericHandlers.SingleHandler">
- <summary>
- A type handler for the PostgreSQL real data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-numeric.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.SingleHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.SingleHandler.ValidateAndGetLength(System.Double,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.SingleHandler.ValidateAndGetLength(System.Single,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.SingleHandler.Write(System.Double,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.SingleHandler.Write(System.Single,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.NumericHandlers.UInt32Handler">
- <summary>
- A type handler for PostgreSQL unsigned 32-bit data types. This is only used for internal types.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-oid.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.UInt32Handler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.UInt32Handler.ValidateAndGetLength(System.UInt32,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.UInt32Handler.Write(System.UInt32,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.NumericHandlers.UInt64Handler">
- <summary>
- A type handler for PostgreSQL unsigned 64-bit data types. This is only used for internal types.
- </summary>
- <remarks>
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.UInt64Handler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.UInt64Handler.ValidateAndGetLength(System.UInt64,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.NumericHandlers.UInt64Handler.Write(System.UInt64,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.RangeHandler`1">
- <summary>
- A type handler for PostgreSQL range types.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/rangetypes.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- <typeparam name="TSubtype">The range subtype.</typeparam>
- </member>
- <member name="P:Npgsql.Internal.TypeHandlers.RangeHandler`1.SubtypeHandler">
- <summary>
- The type handler for the subtype that this range type holds
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.RangeHandler`1.#ctor(Npgsql.PostgresTypes.PostgresType,Npgsql.Internal.TypeHandling.NpgsqlTypeHandler)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.RangeHandler`1.CreateArrayHandler(Npgsql.PostgresTypes.PostgresArrayType,Npgsql.ArrayNullabilityMode)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.RangeHandler`1.CreateRangeHandler(Npgsql.PostgresTypes.PostgresType)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.RangeHandler`1.CreateMultirangeHandler(Npgsql.PostgresTypes.PostgresMultirangeType)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.RangeHandler`1.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.RangeHandler`1.ValidateAndGetLength(NpgsqlTypes.NpgsqlRange{`0},Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.RangeHandler`1.Write(NpgsqlTypes.NpgsqlRange{`0},Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.RangeHandler`2">
- <summary>
- Type handler for PostgreSQL range types.
- </summary>
- <remarks>
- Introduced in PostgreSQL 9.2.
- https://www.postgresql.org/docs/current/static/rangetypes.html
- </remarks>
- <typeparam name="TSubtype1">The main range subtype.</typeparam>
- <typeparam name="TSubtype2">An alternative range subtype.</typeparam>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.RangeHandler`2.#ctor(Npgsql.PostgresTypes.PostgresType,Npgsql.Internal.TypeHandling.NpgsqlTypeHandler)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.RangeHandler`2.ValidateAndGetLength(NpgsqlTypes.NpgsqlRange{`1},Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.RangeHandler`2.Write(NpgsqlTypes.NpgsqlRange{`1},Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.RecordHandler">
- <summary>
- Type handler for PostgreSQL record types.
- </summary>
- <remarks>
- https://www.postgresql.org/docs/current/static/datatype-pseudo.html
-
- Encoding (identical to composite):
- A 32-bit integer with the number of columns, then for each column:
- * An OID indicating the type of the column
- * The length of the column(32-bit integer), or -1 if null
- * The column data encoded as binary
- </remarks>
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.TextHandler">
- <summary>
- A type handler for PostgreSQL character data types (text, char, varchar, xml...).
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/datatype-character.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.TextHandler.#ctor(Npgsql.PostgresTypes.PostgresType,System.Text.Encoding)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.TextHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.TextHandler.ValidateAndGetLength(System.String,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.TextHandler.ValidateAndGetLength(System.Char[],Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.TextHandler.ValidateAndGetLength(System.ArraySegment{System.Char},Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.TextHandler.ValidateAndGetLength(System.Char,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.TextHandler.ValidateAndGetLength(System.Byte[],Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.TextHandler.Write(System.String,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.TextHandler.Write(System.Char[],Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.TextHandler.Write(System.ArraySegment{System.Char},Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.TextHandler.Write(System.Char,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.TextHandler.Write(System.Byte[],Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.TextHandler.GetTextReader(System.IO.Stream)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.UnknownTypeHandler">
- <summary>
- Handles "conversions" for columns sent by the database with unknown OIDs.
- This differs from TextHandler in that its a text-only handler (we don't want to receive binary
- representations of the types registered here).
- Note that this handler is also used in the very initial query that loads the OID mappings
- (chicken and egg problem).
- Also used for sending parameters with unknown types (OID=0)
- </summary>
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.UuidHandler">
- <summary>
- A type handler for the PostgreSQL uuid data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-uuid.html.
-
- The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it
- should be considered somewhat unstable, and may change in breaking ways, including in non-major releases.
- Use it at your own risk.
- </remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.UuidHandler.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.UuidHandler.ValidateAndGetLength(System.Guid,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandlers.UuidHandler.Write(System.Guid,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandlers.VoidHandler">
- <remarks>
- https://www.postgresql.org/docs/current/static/datatype-boolean.html
- </remarks>
- </member>
- <member name="T:Npgsql.Internal.TypeHandling.INpgsqlSimpleTypeHandler`1">
- <summary>
- Type handlers that wish to support reading other types in additional to the main one can
- implement this interface for all those types.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.INpgsqlSimpleTypeHandler`1.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <summary>
- Reads a value of type <typeparamref name="T"/> with the given length from the provided buffer,
- with the assumption that it is entirely present in the provided memory buffer and no I/O will be
- required.
- </summary>
- <param name="buf">The buffer from which to read.</param>
- <param name="len">The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed.</param>
- <param name="fieldDescription">Additional PostgreSQL information about the type, such as the length in varchar(30).</param>
- <returns>The fully-read value.</returns>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.INpgsqlSimpleTypeHandler`1.ValidateAndGetLength(`0,Npgsql.NpgsqlParameter)">
- <summary>
- Responsible for validating that a value represents a value of the correct and which can be
- written for PostgreSQL - if the value cannot be written for any reason, an exception should be thrown.
- Also returns the byte length needed to write the value.
- </summary>
- <param name="value">The value to be written to PostgreSQL</param>
- <param name="parameter">
- The <see cref="T:Npgsql.NpgsqlParameter"/> instance where this value resides. Can be used to access additional
- information relevant to the write process (e.g. <see cref="P:Npgsql.NpgsqlParameter.Size"/>).
- </param>
- <returns>The number of bytes required to write the value.</returns>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.INpgsqlSimpleTypeHandler`1.Write(`0,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <summary>
- Writes a value to the provided buffer, with the assumption that there is enough space in the buffer
- (no I/O will occur). The Npgsql core will have taken care of that.
- </summary>
- <param name="value">The value to write.</param>
- <param name="buf">The buffer to which to write.</param>
- <param name="parameter">
- The <see cref="T:Npgsql.NpgsqlParameter"/> instance where this value resides. Can be used to access additional
- information relevant to the write process (e.g. <see cref="P:Npgsql.NpgsqlParameter.Size"/>).
- </param>
- </member>
- <member name="T:Npgsql.Internal.TypeHandling.INpgsqlTypeHandler`1">
- <summary>
- Type handlers that wish to support reading other types in additional to the main one can
- implement this interface for all those types.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.INpgsqlTypeHandler`1.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
- <summary>
- Reads a value of type <typeparamref name="T"/> with the given length from the provided buffer,
- using either sync or async I/O.
- </summary>
- <param name="buf">The buffer from which to read.</param>
- <param name="len">The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed.</param>
- <param name="async">If I/O is required to read the full length of the value, whether it should be performed synchronously or asynchronously.</param>
- <param name="fieldDescription">Additional PostgreSQL information about the type, such as the length in varchar(30).</param>
- <returns>The fully-read value.</returns>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.INpgsqlTypeHandler`1.ValidateAndGetLength(`0,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <summary>
- Responsible for validating that a value represents a value of the correct and which can be
- written for PostgreSQL - if the value cannot be written for any reason, an exception should be thrown.
- Also returns the byte length needed to write the value.
- </summary>
- <param name="value">The value to be written to PostgreSQL</param>
- <param name="lengthCache">A cache where the length calculated during the validation phase can be stored for use at the writing phase.</param>
- <param name="parameter">
- The <see cref="T:Npgsql.NpgsqlParameter"/> instance where this value resides. Can be used to access additional
- information relevant to the write process (e.g. <see cref="P:Npgsql.NpgsqlParameter.Size"/>).
- </param>
- <returns>The number of bytes required to write the value.</returns>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.INpgsqlTypeHandler`1.Write(`0,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Writes a value to the provided buffer.
- </summary>
- <param name="value">The value to write.</param>
- <param name="buf">The buffer to which to write.</param>
- <param name="lengthCache">A cache where the length calculated during the validation phase can be stored for use at the writing phase.</param>
- <param name="parameter">
- The <see cref="T:Npgsql.NpgsqlParameter"/> instance where this value resides. Can be used to access additional
- information relevant to the write process (e.g. <see cref="P:Npgsql.NpgsqlParameter.Size"/>).
- </param>
- <param name="async">
- If I/O will be necessary (i.e. the buffer is full), determines whether it will be done synchronously or asynchronously.
- </param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- </member>
- <member name="T:Npgsql.Internal.TypeHandling.ITextReaderHandler">
- <summary>
- Implemented by handlers which support <see cref="M:System.Data.Common.DbDataReader.GetTextReader(System.Int32)"/>, returns a standard
- TextReader given a binary Stream.
- </summary>
- </member>
- <member name="T:Npgsql.Internal.TypeHandling.NpgsqlLengthCache">
- <summary>
- An array of cached lengths for the parameters sending process.
-
- When sending parameters, lengths need to be calculated more than once (once for Bind, once for
- an array, once for the string within that array). This cache optimized that. Lengths are added
- to the cache, and then retrieved at the same order.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlLengthCache.Set(System.Int32)">
- <summary>
- Stores a length value in the cache, to be fetched later via <see cref="M:Npgsql.Internal.TypeHandling.NpgsqlLengthCache.Get"/>.
- Called at the <see cref="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler.ValidateAndGetLength``1(``0,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)"/> phase.
- </summary>
- <returns>The length parameter.</returns>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlLengthCache.Get">
- <summary>
- Retrieves a length value previously stored in the cache via <see cref="M:Npgsql.Internal.TypeHandling.NpgsqlLengthCache.Set(System.Int32)"/>.
- Called at the writing phase, after validation has already occurred and the length cache is populated.
- </summary>
- <returns></returns>
- </member>
- <member name="T:Npgsql.Internal.TypeHandling.NpgsqlSimpleTypeHandler`1">
- <summary>
- Base class for all simple type handlers, which read and write short, non-arbitrary lengthed
- values to PostgreSQL. Provides a simpler API to implement when compared to <see cref="T:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler"/> -
- Npgsql takes care of all I/O before calling into this type, so no I/O needs to be performed by it.
- </summary>
- <typeparam name="TDefault">
- The default CLR type that this handler will read and write. For example, calling <see cref="M:System.Data.Common.DbDataReader.GetValue(System.Int32)"/>
- on a column with this handler will return a value with type <typeparamref name="TDefault"/>.
- Type handlers can support additional types by implementing <see cref="T:Npgsql.Internal.TypeHandling.INpgsqlTypeHandler`1"/>.
- </typeparam>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlSimpleTypeHandler`1.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <summary>
- Reads a value of type <typeparamref name="TDefault"/> with the given length from the provided buffer,
- with the assumption that it is entirely present in the provided memory buffer and no I/O will be
- required.
- </summary>
- <param name="buf">The buffer from which to read.</param>
- <param name="len">The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed.</param>
- <param name="fieldDescription">Additional PostgreSQL information about the type, such as the length in varchar(30).</param>
- <returns>The fully-read value.</returns>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlSimpleTypeHandler`1.ValidateAndGetLength(`0,Npgsql.NpgsqlParameter)">
- <summary>
- Responsible for validating that a value represents a value of the correct and which can be
- written for PostgreSQL - if the value cannot be written for any reason, an exception shold be thrown.
- Also returns the byte length needed to write the value.
- </summary>
- <param name="value">The value to be written to PostgreSQL</param>
- <param name="parameter">
- The <see cref="T:Npgsql.NpgsqlParameter"/> instance where this value resides. Can be used to access additional
- information relevant to the write process (e.g. <see cref="P:Npgsql.NpgsqlParameter.Size"/>).
- </param>
- <returns>The number of bytes required to write the value.</returns>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlSimpleTypeHandler`1.Write(`0,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <summary>
- Writes a value to the provided buffer, with the assumption that there is enough space in the buffer
- (no I/O will occur). The Npgsql core will have taken care of that.
- </summary>
- <param name="value">The value to write.</param>
- <param name="buf">The buffer to which to write.</param>
- <param name="parameter">
- The <see cref="T:Npgsql.NpgsqlParameter"/> instance where this value resides. Can be used to access additional
- information relevant to the write process (e.g. <see cref="P:Npgsql.NpgsqlParameter.Size"/>).
- </param>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlSimpleTypeHandler`1.Write(`0,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Simple type handlers override <see cref="M:Npgsql.Internal.TypeHandling.NpgsqlSimpleTypeHandler`1.Write(`0,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)"/> instead of this.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlSimpleTypeHandler`1.ValidateAndGetLength(`0,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <summary>
- Simple type handlers override <see cref="M:Npgsql.Internal.TypeHandling.NpgsqlSimpleTypeHandler`1.ValidateAndGetLength(`0,Npgsql.NpgsqlParameter)"/> instead of this.
- </summary>
- </member>
- <member name="T:Npgsql.Internal.TypeHandling.NpgsqlSimpleTypeHandlerWithPsv`2">
- <summary>
- A simple type handler that supports a provider-specific value in addition to its default value.
- This is necessary mainly in cases where the CLR type cannot represent the full range of the
- PostgreSQL type, and a custom CLR type is needed (e.g. <see cref="T:System.DateTime"/> and
- <see cref="T:NpgsqlTypes.NpgsqlDateTime"/>). The provider-specific type <typeparamref name="TPsv"/> will be returned
- from calls to <see cref="M:System.Data.Common.DbDataReader.GetProviderSpecificValue(System.Int32)"/>.
- </summary>
- <typeparam name="TDefault">
- The default CLR type that this handler will read and write. For example, calling <see cref="M:System.Data.Common.DbDataReader.GetValue(System.Int32)"/>
- on a column with this handler will return a value with type <typeparamref name="TDefault"/>.
- Type handlers can support additional types by implementing <see cref="T:Npgsql.Internal.TypeHandling.INpgsqlTypeHandler`1"/>.
- </typeparam>
- <typeparam name="TPsv">The provider-specific CLR type that this handler will read and write.</typeparam>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlSimpleTypeHandlerWithPsv`2.ReadPsv(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <summary>
- Reads a value of type <typeparamref name="TPsv"/> with the given length from the provided buffer,
- with the assumption that it is entirely present in the provided memory buffer and no I/O will be
- required.
- </summary>
- <param name="buf">The buffer from which to read.</param>
- <param name="len">The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed.</param>
- <param name="fieldDescription">Additional PostgreSQL information about the type, such as the length in varchar(30).</param>
- <returns>The fully-read value.</returns>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlSimpleTypeHandlerWithPsv`2.ReadPsvAsObject(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <summary>
- Reads a column as the type handler's provider-specific type, assuming that it is already entirely
- in memory (i.e. no I/O is necessary). Called by <see cref="T:Npgsql.NpgsqlDataReader"/> in non-sequential mode, which
- buffers entire rows in memory.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlSimpleTypeHandlerWithPsv`2.ReadPsvAsObject(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
- <summary>
- Reads a column as the type handler's provider-specific type. If it is not already entirely in
- memory, sync or async I/O will be performed as specified by <paramref name="async"/>.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlSimpleTypeHandlerWithPsv`2.ValidateAndGetLength(`1,Npgsql.NpgsqlParameter)">
- <summary>
- Responsible for validating that a value represents a value of the correct and which can be
- written for PostgreSQL - if the value cannot be written for any reason, an exception shold be thrown.
- Also returns the byte length needed to write the value.
- </summary>
- <param name="value">The value to be written to PostgreSQL</param>
- <param name="parameter">
- The <see cref="T:Npgsql.NpgsqlParameter"/> instance where this value resides. Can be used to access additional
- information relevant to the write process (e.g. <see cref="P:Npgsql.NpgsqlParameter.Size"/>).
- </param>
- <returns>The number of bytes required to write the value.</returns>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlSimpleTypeHandlerWithPsv`2.Write(`1,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
- <summary>
- Writes a value to the provided buffer, with the assumption that there is enough space in the buffer
- (no I/O will occur). The Npgsql core will have taken care of that.
- </summary>
- <param name="value">The value to write.</param>
- <param name="buf">The buffer to which to write.</param>
- <param name="parameter">
- The <see cref="T:Npgsql.NpgsqlParameter"/> instance where this value resides. Can be used to access additional
- information relevant to the write process (e.g. <see cref="P:Npgsql.NpgsqlParameter.Size"/>).
- </param>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlSimpleTypeHandlerWithPsv`2.CreateArrayHandler(Npgsql.PostgresTypes.PostgresArrayType,Npgsql.ArrayNullabilityMode)">
- <inheeritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler">
- <summary>
- Base class for all type handlers, which read and write CLR types into their PostgreSQL
- binary representation.
- Type handler writers shouldn't inherit from this class, inherit <see cref="T:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler"/>
- or <see cref="T:Npgsql.Internal.TypeHandling.NpgsqlSimpleTypeHandler`1"/> instead.
- </summary>
- </member>
- <member name="P:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler.PostgresType">
- <summary>
- The PostgreSQL type handled by this type handler.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler.Read``1(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
- <summary>
- Reads a value of type <typeparamref name="TAny"/> with the given length from the provided buffer,
- using either sync or async I/O.
- </summary>
- <param name="buf">The buffer from which to read.</param>
- <param name="len">The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed.</param>
- <param name="async">If I/O is required to read the full length of the value, whether it should be performed synchronously or asynchronously.</param>
- <param name="fieldDescription">Additional PostgreSQL information about the type, such as the length in varchar(30).</param>
- <returns>The fully-read value.</returns>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler.Read``1(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <summary>
- Version of <see cref="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler.Read``1(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)"/> that's called when we know the entire value
- is already buffered in memory (i.e. in non-sequential mode).
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler.ReadAsObject(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
- <summary>
- Reads a column as the type handler's default read type. If it is not already entirely in
- memory, sync or async I/O will be performed as specified by <paramref name="async"/>.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler.ReadAsObject(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <summary>
- Version of <see cref="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler.ReadAsObject(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)"/> that's called when we know the entire value
- is already buffered in memory (i.e. in non-sequential mode).
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler.ReadPsvAsObject(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
- <summary>
- Reads a column as the type handler's provider-specific type. If it is not already entirely in
- memory, sync or async I/O will be performed as specified by <paramref name="async"/>.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler.ReadPsvAsObject(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
- <summary>
- Version of <see cref="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler.ReadPsvAsObject(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)"/> that's called when we know the entire value
- is already buffered in memory (i.e. in non-sequential mode).
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler.ReadWithLength``1(Npgsql.Internal.NpgsqlReadBuffer,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
- <summary>
- Reads a value from the buffer, assuming our read position is at the value's preceding length.
- If the length is -1 (null), this method will return the default value.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler.ValidateAndGetLength``1(``0,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <summary>
- <para>Called to validate and get the length of a value of a generic <see cref="T:Npgsql.NpgsqlParameter`1"/>.</para>
- <para><see langword="null"/> and <see cref="T:System.DBNull"/> must be handled before calling into this.</para>
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler.WriteWithLength``1(``0,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Called to write the value of a generic <see cref="T:Npgsql.NpgsqlParameter`1"/>.
- </summary>
- <summary>
- In the vast majority of cases writing a parameter to the buffer won't need to perform I/O.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler.WriteWithLengthCustom``1(``0,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Typically does not need to be overridden by type handlers, but may be needed in some
- cases (e.g. <see cref="T:Npgsql.Internal.TypeHandlers.ArrayHandler"/>.
- Note that this method assumes it can write 4 bytes of length (already verified by
- <see cref="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler.WriteWithLength``1(``0,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)"/>).
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler.ValidateObjectAndGetLength(System.Object,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <summary>
- Responsible for validating that a value represents a value of the correct and which can be
- written for PostgreSQL - if the value cannot be written for any reason, an exception shold be thrown.
- Also returns the byte length needed to write the value.
- </summary>
- <param name="value">The value to be written to PostgreSQL</param>
- <param name="lengthCache">
- If the byte length calculation is costly (e.g. for UTF-8 strings), its result can be stored in the
- length cache to be reused in the writing process, preventing recalculation.
- </param>
- <param name="parameter">
- The <see cref="T:Npgsql.NpgsqlParameter"/> instance where this value resides. Can be used to access additional
- information relevant to the write process (e.g. <see cref="P:Npgsql.NpgsqlParameter.Size"/>).
- </param>
- <returns>The number of bytes required to write the value.</returns>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler.WriteObjectWithLength(System.Object,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Writes a value to the provided buffer, using either sync or async I/O.
- </summary>
- <param name="value">The value to write.</param>
- <param name="buf">The buffer to which to write.</param>
- <param name="lengthCache"></param>
- <param name="parameter">
- The <see cref="T:Npgsql.NpgsqlParameter"/> instance where this value resides. Can be used to access additional
- information relevant to the write process (e.g. <see cref="P:Npgsql.NpgsqlParameter.Size"/>).
- </param>
- <param name="async">If I/O is required to read the full length of the value, whether it should be performed synchronously or asynchronously.</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler.CreateArrayHandler(Npgsql.PostgresTypes.PostgresArrayType,Npgsql.ArrayNullabilityMode)">
- <summary>
- Creates a type handler for arrays of this handler's type.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler.CreateRangeHandler(Npgsql.PostgresTypes.PostgresType)">
- <summary>
- Creates a type handler for ranges of this handler's type.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler.CreateMultirangeHandler(Npgsql.PostgresTypes.PostgresMultirangeType)">
- <summary>
- Creates a type handler for multiranges of this handler's type.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler.CreateConversionButNoParamException(System.Type)">
- <summary>
- Used to create an exception when the provided type can be converted and written, but an
- instance of <see cref="T:Npgsql.NpgsqlParameter"/> is required for caching of the converted value
- (in <see cref="P:Npgsql.NpgsqlParameter.ConvertedValue"/>.
- </summary>
- </member>
- <member name="T:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler`1">
- <summary>
- Base class for all type handlers, which read and write CLR types into their PostgreSQL
- binary representation. Unless your type is arbitrary-length, consider inheriting from
- <see cref="T:Npgsql.Internal.TypeHandling.NpgsqlSimpleTypeHandler`1"/> instead.
- </summary>
- <typeparam name="TDefault">
- The default CLR type that this handler will read and write. For example, calling <see cref="M:System.Data.Common.DbDataReader.GetValue(System.Int32)"/>
- on a column with this handler will return a value with type <typeparamref name="TDefault"/>.
- Type handlers can support additional types by implementing <see cref="T:Npgsql.Internal.TypeHandling.INpgsqlTypeHandler`1"/>.
- </typeparam>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler`1.Read(Npgsql.Internal.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
- <summary>
- Reads a value of type <typeparamref name="TDefault"/> with the given length from the provided buffer,
- using either sync or async I/O.
- </summary>
- <param name="buf">The buffer from which to read.</param>
- <param name="len">The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed.</param>
- <param name="async">If I/O is required to read the full length of the value, whether it should be performed synchronously or asynchronously.</param>
- <param name="fieldDescription">Additional PostgreSQL information about the type, such as the length in varchar(30).</param>
- <returns>The fully-read value.</returns>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler`1.ValidateAndGetLength(`0,Npgsql.Internal.TypeHandling.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
- <summary>
- Called to validate and get the length of a value of a generic <see cref="T:Npgsql.NpgsqlParameter`1"/>.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler`1.Write(`0,Npgsql.Internal.NpgsqlWriteBuffer,Npgsql.Internal.TypeHandling.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Called to write the value of a generic <see cref="T:Npgsql.NpgsqlParameter`1"/>.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler`1.CreateArrayHandler(Npgsql.PostgresTypes.PostgresArrayType,Npgsql.ArrayNullabilityMode)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler`1.CreateRangeHandler(Npgsql.PostgresTypes.PostgresType)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.NpgsqlTypeHandler`1.CreateMultirangeHandler(Npgsql.PostgresTypes.PostgresMultirangeType)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Internal.TypeHandling.TypeHandlerResolver">
- <summary>
- An Npgsql resolver for type handlers. Typically used by plugins to alter how Npgsql reads and writes values to PostgreSQL.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.TypeHandlerResolver.ResolveByDataTypeName(System.String)">
- <summary>
- Resolves a type handler given a PostgreSQL type name, corresponding to the typname column in the PostgreSQL pg_type catalog table.
- </summary>
- <remarks>See <see href="https://www.postgresql.org/docs/current/catalog-pg-type.html" />.</remarks>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.TypeHandlerResolver.ResolveByClrType(System.Type)">
- <summary>
- Resolves a type handler given a .NET CLR type.
- </summary>
- </member>
- <member name="M:Npgsql.Internal.TypeHandling.TypeHandlerResolver.GetMappingByDataTypeName(System.String)">
- <summary>
- Gets type mapping information for a given PostgreSQL type.
- Invoked in scenarios when mapping information is required, rather than a type handler for reading or writing.
- </summary>
- </member>
- <member name="T:Npgsql.KerberosUsernameProvider">
- <summary>
- Launches MIT Kerberos klist and parses out the default principal from it.
- Caches the result.
- </summary>
- </member>
- <member name="T:Npgsql.Logging.ConsoleLoggingProvider">
- <summary>
- An logging provider that outputs Npgsql logging messages to standard error.
- </summary>
- </member>
- <member name="M:Npgsql.Logging.ConsoleLoggingProvider.#ctor(Npgsql.Logging.NpgsqlLogLevel,System.Boolean,System.Boolean)">
- <summary>
- Constructs a new <see cref="T:Npgsql.Logging.ConsoleLoggingProvider"/>
- </summary>
- <param name="minLevel">Only messages of this level of higher will be logged</param>
- <param name="printLevel">If true, will output the log level (e.g. WARN). Defaults to false.</param>
- <param name="printConnectorId">If true, will output the connector ID. Defaults to false.</param>
- </member>
- <member name="M:Npgsql.Logging.ConsoleLoggingProvider.CreateLogger(System.String)">
- <summary>
- Creates a new <see cref="T:Npgsql.Logging.ConsoleLogger"/> instance of the given name.
- </summary>
- </member>
- <member name="T:Npgsql.Logging.INpgsqlLoggingProvider">
- Used to create logger instances of the given name.
- </member>
- <member name="M:Npgsql.Logging.INpgsqlLoggingProvider.CreateLogger(System.String)">
- <summary>
- Creates a new INpgsqlLogger instance of the given name.
- </summary>
- </member>
- <member name="T:Npgsql.Logging.NpgsqlLogger">
- <summary>
- A generic interface for logging.
- </summary>
- </member>
- <member name="T:Npgsql.Logging.NpgsqlLogManager">
- <summary>
- Manages logging for Npgsql, used to set the logging provider.
- </summary>
- </member>
- <member name="P:Npgsql.Logging.NpgsqlLogManager.Provider">
- <summary>
- The logging provider used for logging in Npgsql.
- </summary>
- </member>
- <member name="P:Npgsql.Logging.NpgsqlLogManager.IsParameterLoggingEnabled">
- <summary>
- Determines whether parameter contents will be logged alongside SQL statements - this may reveal sensitive information.
- Defaults to false.
- </summary>
- </member>
- <member name="P:Npgsql.MultiplexingConnectorPool.MultiplexingTypeMapper">
- <summary>
- A pool-wide type mapper used when multiplexing. This is necessary because binding parameters
- to their type handlers happens *before* the command is enqueued for execution, so there's no
- connector yet at that stage.
- </summary>
- </member>
- <member name="F:Npgsql.MultiplexingConnectorPool._writeCoalescingBufferThresholdBytes">
- <summary>
- When multiplexing is enabled, determines the maximum number of outgoing bytes to buffer before
- flushing to the network.
- </summary>
- </member>
- <member name="M:Npgsql.MultiplexingConnectorPool.BootstrapMultiplexing(Npgsql.NpgsqlConnection,Npgsql.Util.NpgsqlTimeout,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Called exactly once per multiplexing pool, when the first connection is opened, with two goals:
- 1. Load types and bind the pool-wide type mapper (necessary for binding parameters)
- 2. Cause any connection exceptions (e.g. bad username) to be thrown from NpgsqlConnection.Open
- </summary>
- </member>
- <member name="T:Npgsql.INpgsqlNameTranslator">
- <summary>
- A component which translates a CLR name (e.g. SomeClass) into a database name (e.g. some_class)
- according to some scheme.
- Used for mapping enum and composite types.
- </summary>
- </member>
- <member name="M:Npgsql.INpgsqlNameTranslator.TranslateTypeName(System.String)">
- <summary>
- Given a CLR type name (e.g class, struct, enum), translates its name to a database type name.
- </summary>
- </member>
- <member name="M:Npgsql.INpgsqlNameTranslator.TranslateMemberName(System.String)">
- <summary>
- Given a CLR member name (property or field), translates its name to a database type name.
- </summary>
- </member>
- <member name="T:Npgsql.NameTranslation.NpgsqlNullNameTranslator">
- <summary>
- A name translator which preserves CLR names (e.g. SomeClass) when mapping names to the database.
- </summary>
- </member>
- <member name="M:Npgsql.NameTranslation.NpgsqlNullNameTranslator.TranslateTypeName(System.String)">
- <summary>
- Given a CLR type name (e.g class, struct, enum), translates its name to a database type name.
- </summary>
- </member>
- <member name="M:Npgsql.NameTranslation.NpgsqlNullNameTranslator.TranslateMemberName(System.String)">
- <summary>
- Given a CLR member name (property or field), translates its name to a database type name.
- </summary>
- </member>
- <member name="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator">
- <summary>
- A name translator which converts standard CLR names (e.g. SomeClass) to snake-case database
- names (some_class)
- </summary>
- </member>
- <member name="M:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator.#ctor">
- <summary>
- Creates a new <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>.
- </summary>
- </member>
- <member name="M:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator.#ctor(System.Boolean)">
- <summary>
- Creates a new <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>.
- </summary>
- <param name="legacyMode">
- Uses the legacy naming convention if <see langword="true"/>, otherwise it uses the new naming convention.
- </param>
- </member>
- <member name="M:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator.TranslateTypeName(System.String)">
- <summary>
- Given a CLR type name (e.g class, struct, enum), translates its name to a database type name.
- </summary>
- </member>
- <member name="M:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator.TranslateMemberName(System.String)">
- <summary>
- Given a CLR member name (property or field), translates its name to a database type name.
- </summary>
- </member>
- <member name="M:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator.ConvertToSnakeCase(System.String)">
- <summary>
- Converts a string to its snake_case equivalent.
- </summary>
- <param name="name">The value to convert.</param>
- </member>
- <member name="T:Npgsql.NoSynchronizationContextScope">
- <summary>
- This mechanism is used to temporarily set the current synchronization context to null while
- executing Npgsql code, making all await continuations execute on the thread pool. This replaces
- the need to place ConfigureAwait(false) everywhere, and should be used in all surface async methods,
- without exception.
-
- Warning: do not use this directly in async methods, use it in sync wrappers of async methods
- (see https://github.com/npgsql/npgsql/issues/1593)
- </summary>
- <remarks>
- https://stackoverflow.com/a/28307965/640325
- </remarks>
- </member>
- <member name="T:Npgsql.NpgsqlBatch">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlBatch.DbBatchCommands">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlBatch.BatchCommands">
- <inheritdoc cref="P:System.Data.Common.DbBatch.BatchCommands"/>
- </member>
- <member name="P:Npgsql.NpgsqlBatch.Timeout">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlBatch.Connection">
- <inheritdoc cref="P:System.Data.Common.DbBatch.Connection"/>
- </member>
- <member name="P:Npgsql.NpgsqlBatch.DbConnection">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlBatch.Transaction">
- <inheritdoc cref="P:System.Data.Common.DbBatch.Transaction"/>
- </member>
- <member name="P:Npgsql.NpgsqlBatch.DbTransaction">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlBatch.AllResultTypesAreUnknown">
- <summary>
- Marks all of the batch's result columns as either known or unknown.
- Unknown results column are requested them from PostgreSQL in text format, and Npgsql makes no
- attempt to parse them. They will be accessible as strings only.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlBatch.#ctor(Npgsql.NpgsqlConnection,Npgsql.NpgsqlTransaction)">
- <summary>
- Initializes a new <see cref="T:Npgsql.NpgsqlBatch"/>.
- </summary>
- <param name="connection">A <see cref="T:Npgsql.NpgsqlConnection"/> that represents the connection to a PostgreSQL server.</param>
- <param name="transaction">The <see cref="T:Npgsql.NpgsqlTransaction"/> in which the <see cref="T:Npgsql.NpgsqlCommand"/> executes.</param>
- </member>
- <member name="M:Npgsql.NpgsqlBatch.CreateDbBatchCommand">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlBatch.ExecuteDbDataReader(System.Data.CommandBehavior)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlBatch.ExecuteReader(System.Data.CommandBehavior)">
- <inheritdoc cref="M:System.Data.Common.DbBatch.ExecuteReader(System.Data.CommandBehavior)"/>
- </member>
- <member name="M:Npgsql.NpgsqlBatch.ExecuteDbDataReaderAsync(System.Data.CommandBehavior,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlBatch.ExecuteReaderAsync(System.Threading.CancellationToken)">
- <inheritdoc cref="M:System.Data.Common.DbBatch.ExecuteReaderAsync(System.Threading.CancellationToken)"/>
- </member>
- <member name="M:Npgsql.NpgsqlBatch.ExecuteReaderAsync(System.Data.CommandBehavior,System.Threading.CancellationToken)">
- <inheritdoc cref="M:System.Data.Common.DbBatch.ExecuteReaderAsync(System.Data.CommandBehavior,System.Threading.CancellationToken)"/>
- </member>
- <member name="M:Npgsql.NpgsqlBatch.ExecuteNonQuery">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlBatch.ExecuteNonQueryAsync(System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlBatch.ExecuteScalar">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlBatch.ExecuteScalarAsync(System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlBatch.Prepare">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlBatch.PrepareAsync(System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlBatch.Cancel">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.NpgsqlBatchCommand">
- <inheritdoc/>
- </member>
- <member name="P:Npgsql.NpgsqlBatchCommand.CommandText">
- <inheritdoc/>
- </member>
- <member name="P:Npgsql.NpgsqlBatchCommand.CommandType">
- <inheritdoc/>
- </member>
- <member name="P:Npgsql.NpgsqlBatchCommand.DbParameterCollection">
- <inheritdoc/>
- </member>
- <member name="P:Npgsql.NpgsqlBatchCommand.Parameters">
- <inheritdoc cref="P:System.Data.Common.DbBatchCommand.Parameters"/>
- </member>
- <member name="P:Npgsql.NpgsqlBatchCommand.Rows">
- <summary>
- The number of rows affected or retrieved.
- </summary>
- <remarks>
- See the command tag in the CommandComplete message for the meaning of this value for each <see cref="P:Npgsql.NpgsqlBatchCommand.StatementType"/>,
- https://www.postgresql.org/docs/current/static/protocol-message-formats.html
- </remarks>
- </member>
- <member name="P:Npgsql.NpgsqlBatchCommand.RecordsAffected">
- <inheritdoc/>
- </member>
- <member name="P:Npgsql.NpgsqlBatchCommand.StatementType">
- <summary>
- Specifies the type of query, e.g. SELECT.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlBatchCommand.OID">
- <summary>
- For an INSERT, the object ID of the inserted row if <see cref="P:Npgsql.NpgsqlBatchCommand.RecordsAffected"/> is 1 and
- the target table has OIDs; otherwise 0.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlBatchCommand.FinalCommandText">
- <summary>
- The SQL as it will be sent to PostgreSQL, after any rewriting performed by Npgsql (e.g. named to positional parameter
- placeholders).
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlBatchCommand.PositionalParameters">
- <summary>
- The list of parameters, ordered positionally, as it will be sent to PostgreSQL.
- </summary>
- <remarks>
- If the user provided positional parameters, this references the <see cref="P:Npgsql.NpgsqlBatchCommand.Parameters"/> (in batching mode) or the list
- backing <see cref="P:Npgsql.NpgsqlCommand.Parameters" /> (in non-batching) mode. If the user provided named parameters, this is a
- separate list containing the re-ordered parameters.
- </remarks>
- </member>
- <member name="P:Npgsql.NpgsqlBatchCommand.Description">
- <summary>
- The RowDescription message for this query. If null, the query does not return rows (e.g. INSERT)
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlBatchCommand.PreparedStatement">
- <summary>
- If this statement has been automatically prepared, references the <see cref="P:Npgsql.NpgsqlBatchCommand.PreparedStatement"/>.
- Null otherwise.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlBatchCommand.StatementName">
- <summary>
- Holds the server-side (prepared) statement name. Empty string for non-prepared statements.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlBatchCommand.IsPrepared">
- <summary>
- Whether this statement has already been prepared (including automatic preparation).
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlBatchCommand.TryGetPrepared(Npgsql.PreparedStatement@)">
- <summary>
- Returns a prepared statement for this statement (including automatic preparation).
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlBatchCommand.#ctor">
- <summary>
- Initializes a new <see cref="T:Npgsql.NpgsqlBatchCommand"/>.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlBatchCommand.#ctor(System.String)">
- <summary>
- Initializes a new <see cref="T:Npgsql.NpgsqlBatchCommand"/>.
- </summary>
- <param name="commandText">The text of the <see cref="T:Npgsql.NpgsqlBatchCommand"/>.</param>
- </member>
- <member name="M:Npgsql.NpgsqlBatchCommand.ToString">
- <summary>
- Returns the <see cref="P:Npgsql.NpgsqlBatchCommand.CommandText"/>.
- </summary>
- </member>
- <member name="T:Npgsql.NpgsqlBatchCommandCollection">
- <inheritdoc cref="T:System.Data.Common.DbBatchCommandCollection"/>
- </member>
- <member name="P:Npgsql.NpgsqlBatchCommandCollection.Count">
- <inheritdoc/>
- </member>
- <member name="P:Npgsql.NpgsqlBatchCommandCollection.IsReadOnly">
- <inheritdoc/>
- </member>
- <member name="M:Npgsql.NpgsqlBatchCommandCollection.GetEnumerator">
- <inheritdoc/>
- </member>
- <member name="M:Npgsql.NpgsqlBatchCommandCollection.Add(Npgsql.NpgsqlBatchCommand)">
- <inheritdoc/>
- </member>
- <member name="M:Npgsql.NpgsqlBatchCommandCollection.Add(System.Data.Common.DbBatchCommand)">
- <inheritdoc/>
- </member>
- <member name="M:Npgsql.NpgsqlBatchCommandCollection.Clear">
- <inheritdoc/>
- </member>
- <member name="M:Npgsql.NpgsqlBatchCommandCollection.Contains(Npgsql.NpgsqlBatchCommand)">
- <inheritdoc/>
- </member>
- <member name="M:Npgsql.NpgsqlBatchCommandCollection.Contains(System.Data.Common.DbBatchCommand)">
- <inheritdoc/>
- </member>
- <member name="M:Npgsql.NpgsqlBatchCommandCollection.CopyTo(Npgsql.NpgsqlBatchCommand[],System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:Npgsql.NpgsqlBatchCommandCollection.CopyTo(System.Data.Common.DbBatchCommand[],System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:Npgsql.NpgsqlBatchCommandCollection.IndexOf(Npgsql.NpgsqlBatchCommand)">
- <inheritdoc/>
- </member>
- <member name="M:Npgsql.NpgsqlBatchCommandCollection.IndexOf(System.Data.Common.DbBatchCommand)">
- <inheritdoc/>
- </member>
- <member name="M:Npgsql.NpgsqlBatchCommandCollection.Insert(System.Int32,Npgsql.NpgsqlBatchCommand)">
- <inheritdoc/>
- </member>
- <member name="M:Npgsql.NpgsqlBatchCommandCollection.Insert(System.Int32,System.Data.Common.DbBatchCommand)">
- <inheritdoc/>
- </member>
- <member name="M:Npgsql.NpgsqlBatchCommandCollection.Remove(Npgsql.NpgsqlBatchCommand)">
- <inheritdoc/>
- </member>
- <member name="M:Npgsql.NpgsqlBatchCommandCollection.Remove(System.Data.Common.DbBatchCommand)">
- <inheritdoc/>
- </member>
- <member name="M:Npgsql.NpgsqlBatchCommandCollection.RemoveAt(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="P:Npgsql.NpgsqlBatchCommandCollection.Item(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:Npgsql.NpgsqlBatchCommandCollection.GetBatchCommand(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:Npgsql.NpgsqlBatchCommandCollection.SetBatchCommand(System.Int32,System.Data.Common.DbBatchCommand)">
- <inheritdoc/>
- </member>
- <member name="T:Npgsql.NpgsqlBinaryExporter">
- <summary>
- Provides an API for a binary COPY TO operation, a high-performance data export mechanism from
- a PostgreSQL table. Initiated by <see cref="M:Npgsql.NpgsqlConnection.BeginBinaryExport(System.String)"/>
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlBinaryExporter.NumColumns">
- <summary>
- The number of columns, as returned from the backend in the CopyInResponse.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlBinaryExporter.Timeout">
- <summary>
- Current timeout
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryExporter.StartRow">
- <summary>
- Starts reading a single row, must be invoked before reading any columns.
- </summary>
- <returns>
- The number of columns in the row. -1 if there are no further rows.
- Note: This will currently be the same value for all rows, but this may change in the future.
- </returns>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryExporter.StartRowAsync(System.Threading.CancellationToken)">
- <summary>
- Starts reading a single row, must be invoked before reading any columns.
- </summary>
- <returns>
- The number of columns in the row. -1 if there are no further rows.
- Note: This will currently be the same value for all rows, but this may change in the future.
- </returns>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryExporter.Read``1">
- <summary>
- Reads the current column, returns its value and moves ahead to the next column.
- If the column is null an exception is thrown.
- </summary>
- <typeparam name="T">
- The type of the column to be read. This must correspond to the actual type or data
- corruption will occur. If in doubt, use <see cref="M:Npgsql.NpgsqlBinaryExporter.Read``1(NpgsqlTypes.NpgsqlDbType)"/> to manually
- specify the type.
- </typeparam>
- <returns>The value of the column</returns>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryExporter.ReadAsync``1(System.Threading.CancellationToken)">
- <summary>
- Reads the current column, returns its value and moves ahead to the next column.
- If the column is null an exception is thrown.
- </summary>
- <typeparam name="T">
- The type of the column to be read. This must correspond to the actual type or data
- corruption will occur. If in doubt, use <see cref="M:Npgsql.NpgsqlBinaryExporter.Read``1(NpgsqlTypes.NpgsqlDbType)"/> to manually
- specify the type.
- </typeparam>
- <returns>The value of the column</returns>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryExporter.Read``1(NpgsqlTypes.NpgsqlDbType)">
- <summary>
- Reads the current column, returns its value according to <paramref name="type"/> and
- moves ahead to the next column.
- If the column is null an exception is thrown.
- </summary>
- <param name="type">
- In some cases <typeparamref name="T"/> isn't enough to infer the data type coming in from the
- database. This parameter can be used to unambiguously specify the type. An example is the JSONB
- type, for which <typeparamref name="T"/> will be a simple string but for which
- <paramref name="type"/> must be specified as <see cref="F:NpgsqlTypes.NpgsqlDbType.Jsonb"/>.
- </param>
- <typeparam name="T">The .NET type of the column to be read.</typeparam>
- <returns>The value of the column</returns>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryExporter.ReadAsync``1(NpgsqlTypes.NpgsqlDbType,System.Threading.CancellationToken)">
- <summary>
- Reads the current column, returns its value according to <paramref name="type"/> and
- moves ahead to the next column.
- If the column is null an exception is thrown.
- </summary>
- <param name="type">
- In some cases <typeparamref name="T"/> isn't enough to infer the data type coming in from the
- database. This parameter can be used to unambiguously specify the type. An example is the JSONB
- type, for which <typeparamref name="T"/> will be a simple string but for which
- <paramref name="type"/> must be specified as <see cref="F:NpgsqlTypes.NpgsqlDbType.Jsonb"/>.
- </param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <typeparam name="T">The .NET type of the column to be read.</typeparam>
- <returns>The value of the column</returns>
- </member>
- <member name="P:Npgsql.NpgsqlBinaryExporter.IsNull">
- <summary>
- Returns whether the current column is null.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryExporter.Skip">
- <summary>
- Skips the current column without interpreting its value.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryExporter.SkipAsync(System.Threading.CancellationToken)">
- <summary>
- Skips the current column without interpreting its value.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryExporter.Cancel">
- <summary>
- Cancels an ongoing export.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryExporter.CancelAsync">
- <summary>
- Async cancels an ongoing export.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryExporter.Dispose">
- <summary>
- Completes that binary export and sets the connection back to idle state
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryExporter.DisposeAsync">
- <summary>
- Async completes that binary export and sets the connection back to idle state
- </summary>
- <returns></returns>
- </member>
- <member name="T:Npgsql.NpgsqlBinaryImporter">
- <summary>
- Provides an API for a binary COPY FROM operation, a high-performance data import mechanism to
- a PostgreSQL table. Initiated by <see cref="M:Npgsql.NpgsqlConnection.BeginBinaryImport(System.String)"/>
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/sql-copy.html.
- </remarks>
- </member>
- <member name="F:Npgsql.NpgsqlBinaryImporter._column">
- <summary>
- The number of columns in the current (not-yet-written) row.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlBinaryImporter.NumColumns">
- <summary>
- The number of columns, as returned from the backend in the CopyInResponse.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlBinaryImporter.Timeout">
- <summary>
- Current timeout
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryImporter.StartRow">
- <summary>
- Starts writing a single row, must be invoked before writing any columns.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryImporter.StartRowAsync(System.Threading.CancellationToken)">
- <summary>
- Starts writing a single row, must be invoked before writing any columns.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryImporter.Write``1(``0)">
- <summary>
- Writes a single column in the current row.
- </summary>
- <param name="value">The value to be written</param>
- <typeparam name="T">
- The type of the column to be written. This must correspond to the actual type or data
- corruption will occur. If in doubt, use <see cref="M:Npgsql.NpgsqlBinaryImporter.Write``1(``0,NpgsqlTypes.NpgsqlDbType)"/> to manually
- specify the type.
- </typeparam>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryImporter.WriteAsync``1(``0,System.Threading.CancellationToken)">
- <summary>
- Writes a single column in the current row.
- </summary>
- <param name="value">The value to be written</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <typeparam name="T">
- The type of the column to be written. This must correspond to the actual type or data
- corruption will occur. If in doubt, use <see cref="M:Npgsql.NpgsqlBinaryImporter.Write``1(``0,NpgsqlTypes.NpgsqlDbType)"/> to manually
- specify the type.
- </typeparam>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryImporter.Write``1(``0,NpgsqlTypes.NpgsqlDbType)">
- <summary>
- Writes a single column in the current row as type <paramref name="npgsqlDbType"/>.
- </summary>
- <param name="value">The value to be written</param>
- <param name="npgsqlDbType">
- In some cases <typeparamref name="T"/> isn't enough to infer the data type to be written to
- the database. This parameter can be used to unambiguously specify the type. An example is
- the JSONB type, for which <typeparamref name="T"/> will be a simple string but for which
- <paramref name="npgsqlDbType"/> must be specified as <see cref="F:NpgsqlTypes.NpgsqlDbType.Jsonb"/>.
- </param>
- <typeparam name="T">The .NET type of the column to be written.</typeparam>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryImporter.WriteAsync``1(``0,NpgsqlTypes.NpgsqlDbType,System.Threading.CancellationToken)">
- <summary>
- Writes a single column in the current row as type <paramref name="npgsqlDbType"/>.
- </summary>
- <param name="value">The value to be written</param>
- <param name="npgsqlDbType">
- In some cases <typeparamref name="T"/> isn't enough to infer the data type to be written to
- the database. This parameter can be used to unambiguously specify the type. An example is
- the JSONB type, for which <typeparamref name="T"/> will be a simple string but for which
- <paramref name="npgsqlDbType"/> must be specified as <see cref="F:NpgsqlTypes.NpgsqlDbType.Jsonb"/>.
- </param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <typeparam name="T">The .NET type of the column to be written.</typeparam>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryImporter.Write``1(``0,System.String)">
- <summary>
- Writes a single column in the current row as type <paramref name="dataTypeName"/>.
- </summary>
- <param name="value">The value to be written</param>
- <param name="dataTypeName">
- In some cases <typeparamref name="T"/> isn't enough to infer the data type to be written to
- the database. This parameter and be used to unambiguously specify the type.
- </param>
- <typeparam name="T">The .NET type of the column to be written.</typeparam>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryImporter.WriteAsync``1(``0,System.String,System.Threading.CancellationToken)">
- <summary>
- Writes a single column in the current row as type <paramref name="dataTypeName"/>.
- </summary>
- <param name="value">The value to be written</param>
- <param name="dataTypeName">
- In some cases <typeparamref name="T"/> isn't enough to infer the data type to be written to
- the database. This parameter and be used to unambiguously specify the type.
- </param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <typeparam name="T">The .NET type of the column to be written.</typeparam>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryImporter.WriteNull">
- <summary>
- Writes a single null column value.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryImporter.WriteNullAsync(System.Threading.CancellationToken)">
- <summary>
- Writes a single null column value.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryImporter.WriteRow(System.Object[])">
- <summary>
- Writes an entire row of columns.
- Equivalent to calling <see cref="M:Npgsql.NpgsqlBinaryImporter.StartRow"/>, followed by multiple <see cref="M:Npgsql.NpgsqlBinaryImporter.Write``1(``0)"/>
- on each value.
- </summary>
- <param name="values">An array of column values to be written as a single row</param>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryImporter.WriteRowAsync(System.Threading.CancellationToken,System.Object[])">
- <summary>
- Writes an entire row of columns.
- Equivalent to calling <see cref="M:Npgsql.NpgsqlBinaryImporter.StartRow"/>, followed by multiple <see cref="M:Npgsql.NpgsqlBinaryImporter.Write``1(``0)"/>
- on each value.
- </summary>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <param name="values">An array of column values to be written as a single row</param>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryImporter.Complete">
- <summary>
- Completes the import operation. The writer is unusable after this operation.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryImporter.CompleteAsync(System.Threading.CancellationToken)">
- <summary>
- Completes the import operation. The writer is unusable after this operation.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryImporter.Dispose">
- <summary>
- <para>
- Terminates the ongoing binary import and puts the connection back into the idle state, where regular commands can be executed.
- </para>
- <para>
- Note that if <see cref="M:Npgsql.NpgsqlBinaryImporter.Complete" /> hasn't been invoked before calling this, the import will be cancelled and all changes will
- be reverted.
- </para>
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryImporter.DisposeAsync">
- <summary>
- <para>
- Async terminates the ongoing binary import and puts the connection back into the idle state, where regular commands can be executed.
- </para>
- <para>
- Note that if <see cref="M:Npgsql.NpgsqlBinaryImporter.CompleteAsync(System.Threading.CancellationToken)" /> hasn't been invoked before calling this, the import will be cancelled and all changes will
- be reverted.
- </para>
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryImporter.Close">
- <summary>
- <para>
- Terminates the ongoing binary import and puts the connection back into the idle state, where regular commands can be executed.
- </para>
- <para>
- Note that if <see cref="M:Npgsql.NpgsqlBinaryImporter.Complete" /> hasn't been invoked before calling this, the import will be cancelled and all changes will
- be reverted.
- </para>
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlBinaryImporter.CloseAsync(System.Threading.CancellationToken)">
- <summary>
- <para>
- Async terminates the ongoing binary import and puts the connection back into the idle state, where regular commands can be executed.
- </para>
- <para>
- Note that if <see cref="M:Npgsql.NpgsqlBinaryImporter.CompleteAsync(System.Threading.CancellationToken)" /> hasn't been invoked before calling this, the import will be cancelled and all changes will
- be reverted.
- </para>
- </summary>
- </member>
- <member name="T:Npgsql.NpgsqlCommand">
- <summary>
- Represents a SQL statement or function (stored procedure) to execute
- against a PostgreSQL database. This class cannot be inherited.
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlCommand._connectorPreparedOn">
- <summary>
- If this command is (explicitly) prepared, references the connector on which the preparation happened.
- Used to detect when the connector was changed (i.e. connection open/close), meaning that the command
- is no longer prepared.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlCommand.IsWrappedByBatch">
- <summary>
- Whether this <see cref="T:Npgsql.NpgsqlCommand" /> is wrapped by an <see cref="T:Npgsql.NpgsqlBatch" />.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlCommand.Statements">
- <summary>
- Returns details about each statement that this command has executed.
- Is only populated when an Execute* method is called.
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlCommand._isCached">
- <summary>
- Whether this command is cached by <see cref="T:Npgsql.NpgsqlConnection" /> and returned by <see cref="M:Npgsql.NpgsqlConnection.CreateCommand" />.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.NpgsqlCommand"/> class.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.NpgsqlCommand"/> class with the text of the query.
- </summary>
- <param name="cmdText">The text of the query.</param>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.#ctor(System.String,Npgsql.NpgsqlConnection)">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.NpgsqlCommand"/> class with the text of the query and a
- <see cref="T:Npgsql.NpgsqlConnection"/>.
- </summary>
- <param name="cmdText">The text of the query.</param>
- <param name="connection">A <see cref="T:Npgsql.NpgsqlConnection"/> that represents the connection to a PostgreSQL server.</param>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.#ctor(System.String,Npgsql.NpgsqlConnection,Npgsql.NpgsqlTransaction)">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.NpgsqlCommand"/> class with the text of the query, a
- <see cref="T:Npgsql.NpgsqlConnection"/>, and the <see cref="T:Npgsql.NpgsqlTransaction"/>.
- </summary>
- <param name="cmdText">The text of the query.</param>
- <param name="connection">A <see cref="T:Npgsql.NpgsqlConnection"/> that represents the connection to a PostgreSQL server.</param>
- <param name="transaction">The <see cref="T:Npgsql.NpgsqlTransaction"/> in which the <see cref="T:Npgsql.NpgsqlCommand"/> executes.</param>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.#ctor(System.Collections.Generic.List{Npgsql.NpgsqlBatchCommand})">
- <summary>
- Used when this <see cref="T:Npgsql.NpgsqlCommand"/> instance is wrapped inside an <see cref="T:Npgsql.NpgsqlBatch"/>.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.#ctor(Npgsql.Internal.NpgsqlConnector,System.Collections.Generic.List{Npgsql.NpgsqlBatchCommand})">
- <summary>
- Used when this <see cref="T:Npgsql.NpgsqlCommand"/> instance is wrapped inside an <see cref="T:Npgsql.NpgsqlBatch"/>.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlCommand.CommandText">
- <summary>
- Gets or sets the SQL statement or function (stored procedure) to execute at the data source.
- </summary>
- <value>The Transact-SQL statement or stored procedure to execute. The default is an empty string.</value>
- </member>
- <member name="P:Npgsql.NpgsqlCommand.CommandTimeout">
- <summary>
- Gets or sets the wait time (in seconds) before terminating the attempt to execute a command and generating an error.
- </summary>
- <value>The time (in seconds) to wait for the command to execute. The default value is 30 seconds.</value>
- </member>
- <member name="P:Npgsql.NpgsqlCommand.CommandType">
- <summary>
- Gets or sets a value indicating how the <see cref="P:Npgsql.NpgsqlCommand.CommandText"/> property is to be interpreted.
- </summary>
- <value>
- One of the <see cref="T:System.Data.CommandType"/> values. The default is <see cref="F:System.Data.CommandType.Text"/>.
- </value>
- </member>
- <member name="P:Npgsql.NpgsqlCommand.DbConnection">
- <summary>
- DB connection.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlCommand.Connection">
- <summary>
- Gets or sets the <see cref="T:Npgsql.NpgsqlConnection"/> used by this instance of the <see cref="T:Npgsql.NpgsqlCommand"/>.
- </summary>
- <value>The connection to a data source. The default value is <see langword="null"/>.</value>
- </member>
- <member name="P:Npgsql.NpgsqlCommand.DesignTimeVisible">
- <summary>
- Design time visible.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlCommand.UpdatedRowSource">
- <summary>
- Gets or sets how command results are applied to the DataRow when used by the
- DbDataAdapter.Update(DataSet) method.
- </summary>
- <value>One of the <see cref="T:System.Data.UpdateRowSource"/> values.</value>
- </member>
- <member name="P:Npgsql.NpgsqlCommand.IsPrepared">
- <summary>
- Returns whether this query will execute as a prepared (compiled) query.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlCommand.AllResultTypesAreUnknown">
- <summary>
- Marks all of the query's result columns as either known or unknown.
- Unknown results column are requested them from PostgreSQL in text format, and Npgsql makes no
- attempt to parse them. They will be accessible as strings only.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlCommand.UnknownResultTypeList">
- <summary>
- Marks the query's result columns as known or unknown, on a column-by-column basis.
- Unknown results column are requested them from PostgreSQL in text format, and Npgsql makes no
- attempt to parse them. They will be accessible as strings only.
- </summary>
- <remarks>
- If the query includes several queries (e.g. SELECT 1; SELECT 2), this will only apply to the first
- one. The rest of the queries will be fetched and parsed as usual.
-
- The array size must correspond exactly to the number of result columns the query returns, or an
- error will be raised.
- </remarks>
- </member>
- <member name="P:Npgsql.NpgsqlCommand.ObjectResultTypes">
- <summary>
- Marks result types to be used when using GetValue on a data reader, on a column-by-column basis.
- Used for Entity Framework 5-6 compability.
- Only primitive numerical types and DateTimeOffset are supported.
- Set the whole array or just a value to null to use default type.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlCommand.State">
- <summary>
- The current state of the command
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.CreateDbParameter">
- <summary>
- Creates a new instance of an <see cref="T:System.Data.Common.DbParameter"/> object.
- </summary>
- <returns>A <see cref="T:System.Data.Common.DbParameter"/> object.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.CreateParameter">
- <summary>
- Creates a new instance of a <see cref="T:Npgsql.NpgsqlParameter"/> object.
- </summary>
- <returns>An <see cref="T:Npgsql.NpgsqlParameter"/> object.</returns>
- </member>
- <member name="P:Npgsql.NpgsqlCommand.DbParameterCollection">
- <summary>
- DB parameter collection.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlCommand.Parameters">
- <summary>
- Gets the <see cref="T:Npgsql.NpgsqlParameterCollection"/>.
- </summary>
- <value>The parameters of the SQL statement or function (stored procedure). The default is an empty collection.</value>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.Prepare">
- <summary>
- Creates a server-side prepared statement on the PostgreSQL server.
- This will make repeated future executions of this command much faster.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.PrepareAsync(System.Threading.CancellationToken)">
- <summary>
- Creates a server-side prepared statement on the PostgreSQL server.
- This will make repeated future executions of this command much faster.
- </summary>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.Unprepare">
- <summary>
- Unprepares a command, closing server-side statements associated with it.
- Note that this only affects commands explicitly prepared with <see cref="M:Npgsql.NpgsqlCommand.Prepare"/>, not
- automatically prepared statements.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.UnprepareAsync(System.Threading.CancellationToken)">
- <summary>
- Unprepares a command, closing server-side statements associated with it.
- Note that this only affects commands explicitly prepared with <see cref="M:Npgsql.NpgsqlCommand.Prepare"/>, not
- automatically prepared statements.
- </summary>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.ExecuteNonQuery">
- <summary>
- Executes a SQL statement against the connection and returns the number of rows affected.
- </summary>
- <returns>The number of rows affected if known; -1 otherwise.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.ExecuteNonQueryAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronous version of <see cref="M:Npgsql.NpgsqlCommand.ExecuteNonQuery"/>
- </summary>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>A task representing the asynchronous operation, with the number of rows affected if known; -1 otherwise.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.ExecuteScalar">
- <summary>
- Executes the query, and returns the first column of the first row
- in the result set returned by the query. Extra columns or rows are ignored.
- </summary>
- <returns>The first column of the first row in the result set,
- or a null reference if the result set is empty.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.ExecuteScalarAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronous version of <see cref="M:Npgsql.NpgsqlCommand.ExecuteScalar"/>
- </summary>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>A task representing the asynchronous operation, with the first column of the
- first row in the result set, or a null reference if the result set is empty.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.ExecuteDbDataReader(System.Data.CommandBehavior)">
- <summary>
- Executes the command text against the connection.
- </summary>
- <returns>A task representing the operation.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.ExecuteDbDataReaderAsync(System.Data.CommandBehavior,System.Threading.CancellationToken)">
- <summary>
- Executes the command text against the connection.
- </summary>
- <param name="behavior">An instance of <see cref="T:System.Data.CommandBehavior"/>.</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>A task representing the asynchronous operation.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.ExecuteReader(System.Data.CommandBehavior)">
- <summary>
- Executes the <see cref="P:Npgsql.NpgsqlCommand.CommandText"/> against the <see cref="P:Npgsql.NpgsqlCommand.Connection"/>
- and returns a <see cref="T:Npgsql.NpgsqlDataReader"/>.
- </summary>
- <param name="behavior">One of the enumeration values that specified the command behavior.</param>
- <returns>A task representing the operation.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.ExecuteReaderAsync(System.Threading.CancellationToken)">
- <summary>
- An asynchronous version of <see cref="M:Npgsql.NpgsqlCommand.ExecuteReader(System.Data.CommandBehavior)"/>, which executes
- the <see cref="P:Npgsql.NpgsqlCommand.CommandText"/> against the <see cref="P:Npgsql.NpgsqlCommand.Connection"/>
- and returns a <see cref="T:Npgsql.NpgsqlDataReader"/>.
- </summary>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>A task representing the asynchronous operation.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.ExecuteReaderAsync(System.Data.CommandBehavior,System.Threading.CancellationToken)">
- <summary>
- An asynchronous version of <see cref="M:Npgsql.NpgsqlCommand.ExecuteReader(System.Data.CommandBehavior)"/>,
- which executes the <see cref="P:Npgsql.NpgsqlCommand.CommandText"/> against the <see cref="P:Npgsql.NpgsqlCommand.Connection"/>
- and returns a <see cref="T:Npgsql.NpgsqlDataReader"/>.
- </summary>
- <param name="behavior">One of the enumeration values that specified the command behavior.</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>A task representing the asynchronous operation.</returns>
- </member>
- <member name="P:Npgsql.NpgsqlCommand.DbTransaction">
- <summary>
- DB transaction.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlCommand.Transaction">
- <summary>
- This property is ignored by Npgsql. PostgreSQL only supports a single transaction at a given time on
- a given connection, and all commands implicitly run inside the current transaction started via
- <see cref="M:Npgsql.NpgsqlConnection.BeginTransaction"/>
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.Cancel">
- <summary>
- Attempts to cancel the execution of an <see cref="T:Npgsql.NpgsqlCommand" />.
- </summary>
- <remarks>As per the specs, no exception will be thrown by this method in case of failure.</remarks>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.Dispose(System.Boolean)">
- <summary>
- Releases the resources used by the <see cref="T:Npgsql.NpgsqlCommand"/>.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.FixupRowDescription(Npgsql.BackendMessages.RowDescriptionMessage,System.Boolean)">
- <summary>
- Fixes up the text/binary flag on result columns.
- Since Prepare() describes a statement rather than a portal, the resulting RowDescription
- will have text format on all result columns. Fix that up.
- </summary>
- <remarks>
- Note that UnknownResultTypeList only applies to the first query, while AllResultTypesAreUnknown applies
- to all of them.
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.System#ICloneable#Clone">
- <summary>
- Create a new command based on this one.
- </summary>
- <returns>A new NpgsqlCommand object.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlCommand.Clone">
- <summary>
- Create a new command based on this one.
- </summary>
- <returns>A new NpgsqlCommand object.</returns>
- </member>
- <member name="E:Npgsql.NpgsqlCommand.Disposed">
- <summary>
- This event is unsupported by Npgsql. Use <see cref="E:System.Data.Common.DbConnection.StateChange"/> instead.
- </summary>
- </member>
- <member name="T:Npgsql.NpgsqlCommandBuilder">
- <summary>
- This class is responsible to create database commands for automatic insert, update and delete operations.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlCommandBuilder.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.NpgsqlCommandBuilder"/> class.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlCommandBuilder.#ctor(Npgsql.NpgsqlDataAdapter)">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.NpgsqlCommandBuilder"/> class.
- </summary>
- <param name="adapter">The adapter.</param>
- </member>
- <member name="P:Npgsql.NpgsqlCommandBuilder.QuotePrefix">
- <summary>
- Gets or sets the beginning character or characters to use when specifying database objects (for example, tables or columns) whose names contain characters such as spaces or reserved tokens.
- </summary>
- <returns>
- The beginning character or characters to use. The default is an empty string.
- </returns>
- <PermissionSet>
- <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" PathDiscovery="*AllFiles*" />
- </PermissionSet>
- </member>
- <member name="P:Npgsql.NpgsqlCommandBuilder.QuoteSuffix">
- <summary>
- Gets or sets the ending character or characters to use when specifying database objects (for example, tables or columns) whose names contain characters such as spaces or reserved tokens.
- </summary>
- <returns>
- The ending character or characters to use. The default is an empty string.
- </returns>
- <PermissionSet>
- <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" PathDiscovery="*AllFiles*" />
- </PermissionSet>
- </member>
- <member name="M:Npgsql.NpgsqlCommandBuilder.DeriveParameters(Npgsql.NpgsqlCommand)">
- <summary>
-
- This method is responsible to derive the command parameter list with values obtained from function definition.
- It clears the Parameters collection of command. Also, if there is any parameter type which is not supported by Npgsql, an InvalidOperationException will be thrown.
- Parameters name will be parameter1, parameter2, ... for CommandType.StoredProcedure and named after the placeholder for CommandType.Text
- </summary>
- <param name="command">NpgsqlCommand whose function parameters will be obtained.</param>
- </member>
- <member name="M:Npgsql.NpgsqlCommandBuilder.GetInsertCommand">
- <summary>
- Gets the automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required
- to perform insertions at the data source.
- </summary>
- <returns>
- The automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required to perform insertions.
- </returns>
- </member>
- <member name="M:Npgsql.NpgsqlCommandBuilder.GetInsertCommand(System.Boolean)">
- <summary>
- Gets the automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required to perform insertions
- at the data source, optionally using columns for parameter names.
- </summary>
- <param name="useColumnsForParameterNames">
- If <see langword="true"/>, generate parameter names matching column names, if possible.
- If <see langword="false"/>, generate <c>@p1</c>, <c>@p2</c>, and so on.
- </param>
- <returns>
- The automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required to perform insertions.
- </returns>
- </member>
- <member name="M:Npgsql.NpgsqlCommandBuilder.GetUpdateCommand">
- <summary>
- Gets the automatically generated System.Data.Common.DbCommand object required
- to perform updates at the data source.
- </summary>
- <returns>
- The automatically generated System.Data.Common.DbCommand object required to perform updates.
- </returns>
- </member>
- <member name="M:Npgsql.NpgsqlCommandBuilder.GetUpdateCommand(System.Boolean)">
- <summary>
- Gets the automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required to perform updates
- at the data source, optionally using columns for parameter names.
- </summary>
- <param name="useColumnsForParameterNames">
- If <see langword="true"/>, generate parameter names matching column names, if possible.
- If <see langword="false"/>, generate <c>@p1</c>, <c>@p2</c>, and so on.
- </param>
- <returns>
- The automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required to perform updates.
- </returns>
- </member>
- <member name="M:Npgsql.NpgsqlCommandBuilder.GetDeleteCommand">
- <summary>
- Gets the automatically generated System.Data.Common.DbCommand object required
- to perform deletions at the data source.
- </summary>
- <returns>
- The automatically generated System.Data.Common.DbCommand object required to perform deletions.
- </returns>
- </member>
- <member name="M:Npgsql.NpgsqlCommandBuilder.GetDeleteCommand(System.Boolean)">
- <summary>
- Gets the automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required to perform deletions
- at the data source, optionally using columns for parameter names.
- </summary>
- <param name="useColumnsForParameterNames">
- If <see langword="true"/>, generate parameter names matching column names, if possible.
- If <see langword="false"/>, generate @p1, @p2, and so on.
- </param>
- <returns>
- The automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required to perform deletions.
- </returns>
- </member>
- <member name="M:Npgsql.NpgsqlCommandBuilder.ApplyParameterInfo(System.Data.Common.DbParameter,System.Data.DataRow,System.Data.StatementType,System.Boolean)">
- <summary>
- Applies the parameter information.
- </summary>
- <param name="p">The parameter.</param>
- <param name="row">The row.</param>
- <param name="statementType">Type of the statement.</param>
- <param name="whereClause">If set to <see langword="true"/> [where clause].</param>
- </member>
- <member name="M:Npgsql.NpgsqlCommandBuilder.GetParameterName(System.Int32)">
- <summary>
- Returns the name of the specified parameter in the format of @p#.
- </summary>
- <param name="parameterOrdinal">The number to be included as part of the parameter's name..</param>
- <returns>
- The name of the parameter with the specified number appended as part of the parameter name.
- </returns>
- </member>
- <member name="M:Npgsql.NpgsqlCommandBuilder.GetParameterName(System.String)">
- <summary>
- Returns the full parameter name, given the partial parameter name.
- </summary>
- <param name="parameterName">The partial name of the parameter.</param>
- <returns>
- The full parameter name corresponding to the partial parameter name requested.
- </returns>
- </member>
- <member name="M:Npgsql.NpgsqlCommandBuilder.GetParameterPlaceholder(System.Int32)">
- <summary>
- Returns the placeholder for the parameter in the associated SQL statement.
- </summary>
- <param name="parameterOrdinal">The number to be included as part of the parameter's name.</param>
- <returns>
- The name of the parameter with the specified number appended.
- </returns>
- </member>
- <member name="M:Npgsql.NpgsqlCommandBuilder.SetRowUpdatingHandler(System.Data.Common.DbDataAdapter)">
- <summary>
- Registers the <see cref="T:Npgsql.NpgsqlCommandBuilder" /> to handle the <see cref="E:Npgsql.NpgsqlDataAdapter.RowUpdating"/> event for a <see cref="T:Npgsql.NpgsqlDataAdapter" />.
- </summary>
- <param name="adapter">The <see cref="T:System.Data.Common.DbDataAdapter" /> to be used for the update.</param>
- </member>
- <member name="M:Npgsql.NpgsqlCommandBuilder.RowUpdatingHandler(System.Object,Npgsql.NpgsqlRowUpdatingEventArgs)">
- <summary>
- Adds an event handler for the <see cref="E:Npgsql.NpgsqlDataAdapter.RowUpdating"/> event.
- </summary>
- <param name="sender">The sender</param>
- <param name="e">A <see cref="T:Npgsql.NpgsqlRowUpdatingEventArgs"/> instance containing information about the event.</param>
- </member>
- <member name="M:Npgsql.NpgsqlCommandBuilder.QuoteIdentifier(System.String)">
- <summary>
- Given an unquoted identifier in the correct catalog case, returns the correct quoted form of that identifier, including properly escaping any embedded quotes in the identifier.
- </summary>
- <param name="unquotedIdentifier">The original unquoted identifier.</param>
- <returns>
- The quoted version of the identifier. Embedded quotes within the identifier are properly escaped.
- </returns>
- <PermissionSet>
- <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" PathDiscovery="*AllFiles*" />
- </PermissionSet>
- <exception cref="T:System.ArgumentNullException">Unquoted identifier parameter cannot be null</exception>
- </member>
- <member name="M:Npgsql.NpgsqlCommandBuilder.UnquoteIdentifier(System.String)">
- <summary>
- Given a quoted identifier, returns the correct unquoted form of that identifier, including properly un-escaping any embedded quotes in the identifier.
- </summary>
- <param name="quotedIdentifier">The identifier that will have its embedded quotes removed.</param>
- <returns>
- The unquoted identifier, with embedded quotes properly un-escaped.
- </returns>
- <PermissionSet>
- <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" PathDiscovery="*AllFiles*" />
- </PermissionSet>
- <exception cref="T:System.ArgumentNullException">Quoted identifier parameter cannot be null</exception>
- </member>
- <member name="T:Npgsql.NpgsqlConnection">
- <summary>
- This class represents a connection to a PostgreSQL server.
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlConnection._userFacingConnectionString">
- <summary>
- The connection string, without the password after open (unless Persist Security Info=true)
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlConnection._connectionString">
- <summary>
- The original connection string provided by the user, including the password.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.Connector">
- <summary>
- The physical connection to the database. This is <see langword="null"/> when the connection is closed,
- and also when it is open in multiplexing mode and unbound (e.g. not in a transaction).
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.Settings">
- <summary>
- The parsed connection string. Set only after the connection is opened.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.CachedCommand">
- <summary>
- A cached command handed out by <see cref="M:Npgsql.NpgsqlConnection.CreateCommand" />, which is returned when disposed. Useful for reducing allocations.
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlConnection._closing">
- <summary>
- Flag used to make sure we never double-close a connection, returning it twice to the pool.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.GlobalTypeMapper">
- <summary>
- The global type mapper, which contains defaults used by all new connections.
- Modify mappings on this mapper to affect your entire application.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.TypeMapper">
- <summary>
- The connection-specific type mapper - all modifications affect this connection only,
- and are lost when it is closed.
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlConnection.DefaultPort">
- <summary>
- The default TCP/IP port for PostgreSQL.
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlConnection.TimeoutLimit">
- <summary>
- Maximum value for connection timeout.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.ConnectorBindingScope">
- <summary>
- Tracks when this connection was bound to a physical connector (e.g. at open-time, when a transaction
- was started...).
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.NpgsqlConnection"/> class.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.#ctor(System.String)">
- <summary>
- Initializes a new instance of <see cref="T:Npgsql.NpgsqlConnection"/> with the given connection string.
- </summary>
- <param name="connectionString">The connection used to open the PostgreSQL database.</param>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.Open">
- <summary>
- Opens a database connection with the property settings specified by the <see cref="P:Npgsql.NpgsqlConnection.ConnectionString"/>.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.OpenAsync(System.Threading.CancellationToken)">
- <summary>
- This is the asynchronous version of <see cref="M:Npgsql.NpgsqlConnection.Open"/>.
- </summary>
- <remarks>
- Do not invoke other methods and properties of the <see cref="T:Npgsql.NpgsqlConnection"/> object until the returned Task is complete.
- </remarks>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>A task representing the asynchronous operation.</returns>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.ConnectionString">
- <summary>
- Gets or sets the string used to connect to a PostgreSQL database. See the manual for details.
- </summary>
- <value>The connection string that includes the server name,
- the database name, and other parameters needed to establish
- the initial connection. The default value is an empty string.
- </value>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.ProvidePasswordCallback">
- <summary>
- Gets or sets the delegate used to generate a password for new database connections.
- </summary>
- <remarks>
- <p>
- This delegate is executed when a new database connection is opened that requires a password.
- </p>
- <p>
- The <see cref="P:Npgsql.NpgsqlConnectionStringBuilder.Password"/> and <see cref="P:Npgsql.NpgsqlConnectionStringBuilder.Passfile"/> connection
- string properties have precedence over this delegate: it will not be executed if a password is specified, or if the specified or
- default Passfile contains a valid entry.
- </p>
- <p>
- Due to connection pooling this delegate is only executed when a new physical connection is opened, not when reusing a connection
- that was previously opened from the pool.
- </p>
- </remarks>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.PhysicalOpenCallback">
- <summary>
- Gets or sets the delegate used to setup a connection whenever a physical connection is opened synchronously.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.PhysicalOpenAsyncCallback">
- <summary>
- Gets or sets the delegate used to setup a connection whenever a physical connection is opened asynchronously.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.Host">
- <summary>
- Backend server host name.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.Port">
- <summary>
- Backend server port.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.ConnectionTimeout">
- <summary>
- Gets the time (in seconds) to wait while trying to establish a connection
- before terminating the attempt and generating an error.
- </summary>
- <value>The time (in seconds) to wait for a connection to open. The default value is 15 seconds.</value>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.CommandTimeout">
- <summary>
- Gets the time (in seconds) to wait while trying to execute a command
- before terminating the attempt and generating an error.
- </summary>
- <value>The time (in seconds) to wait for a command to complete. The default value is 20 seconds.</value>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.Database">
- <summary>
- Gets the name of the current database or the database to be used after a connection is opened.
- </summary>
- <value>The name of the current database or the name of the database to be
- used after a connection is opened. The default value is the empty string.</value>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.DataSource">
- <summary>
- Gets the string identifying the database server (host and port)
- </summary>
- <value>
- The name of the database server (host and port). If the connection uses a Unix-domain socket,
- the path to that socket is returned. The default value is the empty string.
- </value>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.IntegratedSecurity">
- <summary>
- Whether to use Windows integrated security to log in.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.UserName">
- <summary>
- User name.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.FullState">
- <summary>
- Gets the current state of the connection.
- </summary>
- <value>A bitwise combination of the <see cref="T:System.Data.ConnectionState"/> values. The default is <b>Closed</b>.</value>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.State">
- <summary>
- Gets whether the current state of the connection is Open or Closed
- </summary>
- <value>ConnectionState.Open, ConnectionState.Closed or ConnectionState.Connecting</value>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.CreateDbCommand">
- <summary>
- Creates and returns a <see cref="T:System.Data.Common.DbCommand"/>
- object associated with the <see cref="T:System.Data.Common.DbConnection"/>.
- </summary>
- <returns>A <see cref="T:System.Data.Common.DbCommand"/> object.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.CreateCommand">
- <summary>
- Creates and returns a <see cref="T:Npgsql.NpgsqlCommand"/> object associated with the <see cref="T:Npgsql.NpgsqlConnection"/>.
- </summary>
- <returns>A <see cref="T:Npgsql.NpgsqlCommand"/> object.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.CreateBatch">
- <summary>
- Creates and returns a <see cref="T:Npgsql.NpgsqlBatch"/> object associated with the <see cref="T:Npgsql.NpgsqlConnection"/>.
- </summary>
- <returns>A <see cref="T:Npgsql.NpgsqlBatch"/> object.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.BeginDbTransaction(System.Data.IsolationLevel)">
- <summary>
- Begins a database transaction with the specified isolation level.
- </summary>
- <param name="isolationLevel">The isolation level under which the transaction should run.</param>
- <returns>A <see cref="T:System.Data.Common.DbTransaction"/> object representing the new transaction.</returns>
- <remarks>Nested transactions are not supported.</remarks>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.BeginTransaction">
- <summary>
- Begins a database transaction.
- </summary>
- <returns>A <see cref="T:Npgsql.NpgsqlTransaction"/> object representing the new transaction.</returns>
- <remarks>
- Nested transactions are not supported.
- Transactions created by this method will have the <see cref="F:System.Data.IsolationLevel.ReadCommitted"/> isolation level.
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.BeginTransaction(System.Data.IsolationLevel)">
- <summary>
- Begins a database transaction with the specified isolation level.
- </summary>
- <param name="level">The isolation level under which the transaction should run.</param>
- <returns>A <see cref="T:Npgsql.NpgsqlTransaction"/> object representing the new transaction.</returns>
- <remarks>Nested transactions are not supported.</remarks>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.BeginDbTransactionAsync(System.Data.IsolationLevel,System.Threading.CancellationToken)">
- <summary>
- Asynchronously begins a database transaction.
- </summary>
- <param name="isolationLevel">The isolation level under which the transaction should run.</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>A task whose <see cref="P:System.Threading.Tasks.ValueTask`1.Result"/> property is an object representing the new transaction.</returns>
- <remarks>
- Nested transactions are not supported.
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.BeginTransactionAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously begins a database transaction.
- </summary>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>A task whose Result property is an object representing the new transaction.</returns>
- <remarks>
- Nested transactions are not supported.
- Transactions created by this method will have the <see cref="F:System.Data.IsolationLevel.ReadCommitted"/> isolation level.
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.BeginTransactionAsync(System.Data.IsolationLevel,System.Threading.CancellationToken)">
- <summary>
- Asynchronously begins a database transaction.
- </summary>
- <param name="level">The isolation level under which the transaction should run.</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>A task whose <see cref="P:System.Threading.Tasks.ValueTask`1.Result"/> property is an object representing the new transaction.</returns>
- <remarks>
- Nested transactions are not supported.
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.EnlistTransaction(System.Transactions.Transaction)">
- <summary>
- Enlist transaction.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.Close">
- <summary>
- Releases the connection. If the connection is pooled, it will be returned to the pool and made available for re-use.
- If it is non-pooled, the physical connection will be closed.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.CloseAsync">
- <summary>
- Releases the connection. If the connection is pooled, it will be returned to the pool and made available for re-use.
- If it is non-pooled, the physical connection will be closed.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.Dispose(System.Boolean)">
- <summary>
- Releases all resources used by the <see cref="T:Npgsql.NpgsqlConnection"/>.
- </summary>
- <param name="disposing"><see langword="true"/> when called from <see cref="M:Npgsql.NpgsqlConnection.Dispose(System.Boolean)"/>;
- <see langword="false"/> when being called from the finalizer.</param>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.DisposeAsync">
- <summary>
- Releases all resources used by the <see cref="T:Npgsql.NpgsqlConnection"/>.
- </summary>
- </member>
- <member name="E:Npgsql.NpgsqlConnection.Notice">
- <summary>
- Fires when PostgreSQL notices are received from PostgreSQL.
- </summary>
- <remarks>
- PostgreSQL notices are non-critical messages generated by PostgreSQL, either as a result of a user query
- (e.g. as a warning or informational notice), or due to outside activity (e.g. if the database administrator
- initiates a "fast" database shutdown).
-
- Note that notices are very different from notifications (see the <see cref="E:Npgsql.NpgsqlConnection.Notification"/> event).
- </remarks>
- </member>
- <member name="E:Npgsql.NpgsqlConnection.Notification">
- <summary>
- Fires when PostgreSQL notifications are received from PostgreSQL.
- </summary>
- <remarks>
- PostgreSQL notifications are sent when your connection has registered for notifications on a specific channel via the
- LISTEN command. NOTIFY can be used to generate such notifications, allowing for an inter-connection communication channel.
-
- Note that notifications are very different from notices (see the <see cref="E:Npgsql.NpgsqlConnection.Notice"/> event).
- </remarks>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.IsSecure">
- <summary>
- Returns whether SSL is being used for the connection.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.IsScram">
- <summary>
- Returns whether SCRAM-SHA256 is being user for the connection
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.IsScramPlus">
- <summary>
- Returns whether SCRAM-SHA256-PLUS is being user for the connection
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.ProvideClientCertificatesCallback">
- <summary>
- Selects the local Secure Sockets Layer (SSL) certificate used for authentication.
- </summary>
- <remarks>
- See <see href="https://msdn.microsoft.com/en-us/library/system.net.security.localcertificateselectioncallback(v=vs.110).aspx"/>
- </remarks>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.UserCertificateValidationCallback">
- <summary>
- Verifies the remote Secure Sockets Layer (SSL) certificate used for authentication.
- Ignored if <see cref="P:Npgsql.NpgsqlConnectionStringBuilder.SslMode"/> is set to <see cref="F:Npgsql.SslMode.Allow"/>,
- <see cref="F:Npgsql.SslMode.Prefer"/> or <see cref="F:Npgsql.SslMode.Require"/>.
- </summary>
- <remarks>
- See <see href="https://msdn.microsoft.com/en-us/library/system.net.security.remotecertificatevalidationcallback(v=vs.110).aspx"/>
- </remarks>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.PostgreSqlVersion">
- <summary>
- The version of the PostgreSQL server we're connected to.
- <remarks>
- <p>
- This can only be called when the connection is open.
- </p>
- <p>
- In case of a development or pre-release version this field will contain
- the version of the next version to be released from this branch.
- </p>
- </remarks>
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.ServerVersion">
- <summary>
- The PostgreSQL server version as returned by the server_version option.
- <remarks>
- This can only be called when the connection is open.
- </remarks>
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.ProcessID">
- <summary>
- Process id of backend server.
- This can only be called when there is an active connection.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.HasIntegerDateTimes">
- <summary>
- Reports whether the backend uses the newer integer timestamp representation.
- Note that the old floating point representation is not supported.
- Meant for use by type plugins (e.g. NodaTime)
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.Timezone">
- <summary>
- The connection's timezone as reported by PostgreSQL, in the IANA/Olson database format.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.PostgresParameters">
- <summary>
- Holds all PostgreSQL parameters received for this connection. Is updated if the values change
- (e.g. as a result of a SET command).
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.BeginBinaryImport(System.String)">
- <summary>
- Begins a binary COPY FROM STDIN operation, a high-performance data import mechanism to a PostgreSQL table.
- </summary>
- <param name="copyFromCommand">A COPY FROM STDIN SQL command</param>
- <returns>A <see cref="T:Npgsql.NpgsqlBinaryImporter"/> which can be used to write rows and columns</returns>
- <remarks>
- See https://www.postgresql.org/docs/current/static/sql-copy.html.
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.BeginBinaryImportAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Begins a binary COPY FROM STDIN operation, a high-performance data import mechanism to a PostgreSQL table.
- </summary>
- <param name="copyFromCommand">A COPY FROM STDIN SQL command</param>
- <param name="cancellationToken">An optional token to cancel the asynchronous operation. The default value is None.</param>
- <returns>A <see cref="T:Npgsql.NpgsqlBinaryImporter"/> which can be used to write rows and columns</returns>
- <remarks>
- See https://www.postgresql.org/docs/current/static/sql-copy.html.
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.BeginBinaryExport(System.String)">
- <summary>
- Begins a binary COPY TO STDOUT operation, a high-performance data export mechanism from a PostgreSQL table.
- </summary>
- <param name="copyToCommand">A COPY TO STDOUT SQL command</param>
- <returns>A <see cref="T:Npgsql.NpgsqlBinaryExporter"/> which can be used to read rows and columns</returns>
- <remarks>
- See https://www.postgresql.org/docs/current/static/sql-copy.html.
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.BeginBinaryExportAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Begins a binary COPY TO STDOUT operation, a high-performance data export mechanism from a PostgreSQL table.
- </summary>
- <param name="copyToCommand">A COPY TO STDOUT SQL command</param>
- <param name="cancellationToken">An optional token to cancel the asynchronous operation. The default value is None.</param>
- <returns>A <see cref="T:Npgsql.NpgsqlBinaryExporter"/> which can be used to read rows and columns</returns>
- <remarks>
- See https://www.postgresql.org/docs/current/static/sql-copy.html.
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.BeginTextImport(System.String)">
- <summary>
- Begins a textual COPY FROM STDIN operation, a data import mechanism to a PostgreSQL table.
- It is the user's responsibility to send the textual input according to the format specified
- in <paramref name="copyFromCommand"/>.
- </summary>
- <param name="copyFromCommand">A COPY FROM STDIN SQL command</param>
- <returns>
- A TextWriter that can be used to send textual data.</returns>
- <remarks>
- See https://www.postgresql.org/docs/current/static/sql-copy.html.
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.BeginTextImportAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Begins a textual COPY FROM STDIN operation, a data import mechanism to a PostgreSQL table.
- It is the user's responsibility to send the textual input according to the format specified
- in <paramref name="copyFromCommand"/>.
- </summary>
- <param name="copyFromCommand">A COPY FROM STDIN SQL command</param>
- <param name="cancellationToken">An optional token to cancel the asynchronous operation. The default value is None.</param>
- <returns>
- A TextWriter that can be used to send textual data.</returns>
- <remarks>
- See https://www.postgresql.org/docs/current/static/sql-copy.html.
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.BeginTextExport(System.String)">
- <summary>
- Begins a textual COPY TO STDOUT operation, a data export mechanism from a PostgreSQL table.
- It is the user's responsibility to parse the textual input according to the format specified
- in <paramref name="copyToCommand"/>.
- </summary>
- <param name="copyToCommand">A COPY TO STDOUT SQL command</param>
- <returns>
- A TextReader that can be used to read textual data.</returns>
- <remarks>
- See https://www.postgresql.org/docs/current/static/sql-copy.html.
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.BeginTextExportAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Begins a textual COPY TO STDOUT operation, a data export mechanism from a PostgreSQL table.
- It is the user's responsibility to parse the textual input according to the format specified
- in <paramref name="copyToCommand"/>.
- </summary>
- <param name="copyToCommand">A COPY TO STDOUT SQL command</param>
- <param name="cancellationToken">An optional token to cancel the asynchronous operation. The default value is None.</param>
- <returns>
- A TextReader that can be used to read textual data.</returns>
- <remarks>
- See https://www.postgresql.org/docs/current/static/sql-copy.html.
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.BeginRawBinaryCopy(System.String)">
- <summary>
- Begins a raw binary COPY operation (TO STDOUT or FROM STDIN), a high-performance data export/import mechanism to a PostgreSQL table.
- Note that unlike the other COPY API methods, <see cref="M:Npgsql.NpgsqlConnection.BeginRawBinaryCopy(System.String)"/> doesn't implement any encoding/decoding
- and is unsuitable for structured import/export operation. It is useful mainly for exporting a table as an opaque
- blob, for the purpose of importing it back later.
- </summary>
- <param name="copyCommand">A COPY TO STDOUT or COPY FROM STDIN SQL command</param>
- <returns>A <see cref="T:Npgsql.NpgsqlRawCopyStream"/> that can be used to read or write raw binary data.</returns>
- <remarks>
- See https://www.postgresql.org/docs/current/static/sql-copy.html.
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.BeginRawBinaryCopyAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Begins a raw binary COPY operation (TO STDOUT or FROM STDIN), a high-performance data export/import mechanism to a PostgreSQL table.
- Note that unlike the other COPY API methods, <see cref="M:Npgsql.NpgsqlConnection.BeginRawBinaryCopyAsync(System.String,System.Threading.CancellationToken)"/> doesn't implement any encoding/decoding
- and is unsuitable for structured import/export operation. It is useful mainly for exporting a table as an opaque
- blob, for the purpose of importing it back later.
- </summary>
- <param name="copyCommand">A COPY TO STDOUT or COPY FROM STDIN SQL command</param>
- <param name="cancellationToken">An optional token to cancel the asynchronous operation. The default value is None.</param>
- <returns>A <see cref="T:Npgsql.NpgsqlRawCopyStream"/> that can be used to read or write raw binary data.</returns>
- <remarks>
- See https://www.postgresql.org/docs/current/static/sql-copy.html.
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.MapEnum``1(System.String,Npgsql.INpgsqlNameTranslator)">
- <summary>
- Maps a CLR enum to a PostgreSQL enum type for use with this connection.
- </summary>
- <remarks>
- CLR enum labels are mapped by name to PostgreSQL enum labels.
- The translation strategy can be controlled by the <paramref name="nameTranslator"/> parameter,
- which defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>.
- You can also use the <see cref="T:NpgsqlTypes.PgNameAttribute"/> on your enum fields to manually specify a PostgreSQL enum label.
- If there is a discrepancy between the .NET and database labels while an enum is read or written,
- an exception will be raised.
-
- Can only be invoked on an open connection; if the connection is closed the mapping is lost.
-
- To avoid mapping the type for each connection, use the <see cref="M:Npgsql.NpgsqlConnection.MapEnumGlobally``1(System.String,Npgsql.INpgsqlNameTranslator)"/> method.
- </remarks>
- <param name="pgName">
- A PostgreSQL type name for the corresponding enum type in the database.
- If null, the name translator given in <paramref name="nameTranslator"/>will be used.
- </param>
- <param name="nameTranslator">
- A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
- Defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>
- </param>
- <typeparam name="TEnum">The .NET enum type to be mapped</typeparam>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.MapEnumGlobally``1(System.String,Npgsql.INpgsqlNameTranslator)">
- <summary>
- Maps a CLR enum to a PostgreSQL enum type for use with all connections created from now on. Existing connections aren't affected.
- </summary>
- <remarks>
- CLR enum labels are mapped by name to PostgreSQL enum labels.
- The translation strategy can be controlled by the <paramref name="nameTranslator"/> parameter,
- which defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>.
- You can also use the <see cref="T:NpgsqlTypes.PgNameAttribute"/> on your enum fields to manually specify a PostgreSQL enum label.
- If there is a discrepancy between the .NET and database labels while an enum is read or written,
- an exception will be raised.
-
- To map the type for a specific connection, use the <see cref="M:Npgsql.NpgsqlConnection.MapEnum``1(System.String,Npgsql.INpgsqlNameTranslator)"/> method.
- </remarks>
- <param name="pgName">
- A PostgreSQL type name for the corresponding enum type in the database.
- If null, the name translator given in <paramref name="nameTranslator"/>will be used.
- </param>
- <param name="nameTranslator">
- A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
- Defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>
- </param>
- <typeparam name="TEnum">The .NET enum type to be mapped</typeparam>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.UnmapEnumGlobally``1(System.String,Npgsql.INpgsqlNameTranslator)">
- <summary>
- Removes a previous global enum mapping.
- </summary>
- <param name="pgName">
- A PostgreSQL type name for the corresponding enum type in the database.
- If null, the name translator given in <paramref name="nameTranslator"/>will be used.
- </param>
- <param name="nameTranslator">
- A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
- Defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>
- </param>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.MapComposite``1(System.String,Npgsql.INpgsqlNameTranslator)">
- <summary>
- Maps a CLR type to a PostgreSQL composite type for use with this connection.
- </summary>
- <remarks>
- CLR fields and properties by string to PostgreSQL enum labels.
- The translation strategy can be controlled by the <paramref name="nameTranslator"/> parameter,
- which defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>.
- You can also use the <see cref="T:NpgsqlTypes.PgNameAttribute"/> on your members to manually specify a PostgreSQL enum label.
- If there is a discrepancy between the .NET and database labels while a composite is read or written,
- an exception will be raised.
-
- Can only be invoked on an open connection; if the connection is closed the mapping is lost.
-
- To avoid mapping the type for each connection, use the <see cref="M:Npgsql.NpgsqlConnection.MapCompositeGlobally``1(System.String,Npgsql.INpgsqlNameTranslator)"/> method.
- </remarks>
- <param name="pgName">
- A PostgreSQL type name for the corresponding enum type in the database.
- If null, the name translator given in <paramref name="nameTranslator"/>will be used.
- </param>
- <param name="nameTranslator">
- A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
- Defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>
- </param>
- <typeparam name="T">The .NET type to be mapped</typeparam>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.MapCompositeGlobally``1(System.String,Npgsql.INpgsqlNameTranslator)">
- <summary>
- Maps a CLR type to a PostgreSQL composite type for use with all connections created from now on. Existing connections aren't affected.
- </summary>
- <remarks>
- CLR fields and properties by string to PostgreSQL enum labels.
- The translation strategy can be controlled by the <paramref name="nameTranslator"/> parameter,
- which defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>.
- You can also use the <see cref="T:NpgsqlTypes.PgNameAttribute"/> on your members to manually specify a PostgreSQL enum label.
- If there is a discrepancy between the .NET and database labels while a composite is read or written,
- an exception will be raised.
-
- To map the type for a specific connection, use the <see cref="M:Npgsql.NpgsqlConnection.MapEnum``1(System.String,Npgsql.INpgsqlNameTranslator)"/> method.
- </remarks>
- <param name="pgName">
- A PostgreSQL type name for the corresponding enum type in the database.
- If null, the name translator given in <paramref name="nameTranslator"/>will be used.
- </param>
- <param name="nameTranslator">
- A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
- Defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>
- </param>
- <typeparam name="T">The .NET type to be mapped</typeparam>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.UnmapCompositeGlobally``1(System.String,Npgsql.INpgsqlNameTranslator)">
- <summary>
- Removes a previous global enum mapping.
- </summary>
- <param name="pgName">
- A PostgreSQL type name for the corresponding enum type in the database.
- If null, the name translator given in <paramref name="nameTranslator"/>will be used.
- </param>
- <param name="nameTranslator">
- A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
- Defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>
- </param>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.Wait(System.Int32)">
- <summary>
- Waits until an asynchronous PostgreSQL messages (e.g. a notification) arrives, and
- exits immediately. The asynchronous message is delivered via the normal events
- (<see cref="E:Npgsql.NpgsqlConnection.Notification"/>, <see cref="E:Npgsql.NpgsqlConnection.Notice"/>).
- </summary>
- <param name="timeout">
- The time-out value, in milliseconds, passed to <see cref="P:System.Net.Sockets.Socket.ReceiveTimeout"/>.
- The default value is 0, which indicates an infinite time-out period.
- Specifying -1 also indicates an infinite time-out period.
- </param>
- <returns>true if an asynchronous message was received, false if timed out.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.Wait(System.TimeSpan)">
- <summary>
- Waits until an asynchronous PostgreSQL messages (e.g. a notification) arrives, and
- exits immediately. The asynchronous message is delivered via the normal events
- (<see cref="E:Npgsql.NpgsqlConnection.Notification"/>, <see cref="E:Npgsql.NpgsqlConnection.Notice"/>).
- </summary>
- <param name="timeout">
- The time-out value is passed to <see cref="P:System.Net.Sockets.Socket.ReceiveTimeout"/>.
- </param>
- <returns>true if an asynchronous message was received, false if timed out.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.Wait">
- <summary>
- Waits until an asynchronous PostgreSQL messages (e.g. a notification) arrives, and
- exits immediately. The asynchronous message is delivered via the normal events
- (<see cref="E:Npgsql.NpgsqlConnection.Notification"/>, <see cref="E:Npgsql.NpgsqlConnection.Notice"/>).
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.WaitAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Waits asynchronously until an asynchronous PostgreSQL messages (e.g. a notification)
- arrives, and exits immediately. The asynchronous message is delivered via the normal events
- (<see cref="E:Npgsql.NpgsqlConnection.Notification"/>, <see cref="E:Npgsql.NpgsqlConnection.Notice"/>).
- </summary>
- <param name="timeout">
- The time-out value, in milliseconds.
- The default value is 0, which indicates an infinite time-out period.
- Specifying -1 also indicates an infinite time-out period.
- </param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>true if an asynchronous message was received, false if timed out.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.WaitAsync(System.TimeSpan,System.Threading.CancellationToken)">
- <summary>
- Waits asynchronously until an asynchronous PostgreSQL messages (e.g. a notification)
- arrives, and exits immediately. The asynchronous message is delivered via the normal events
- (<see cref="E:Npgsql.NpgsqlConnection.Notification"/>, <see cref="E:Npgsql.NpgsqlConnection.Notice"/>).
- </summary>
- <param name="timeout">
- The time-out value as <see cref="T:System.TimeSpan"/>
- </param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>true if an asynchronous message was received, false if timed out.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.WaitAsync(System.Threading.CancellationToken)">
- <summary>
- Waits asynchronously until an asynchronous PostgreSQL messages (e.g. a notification)
- arrives, and exits immediately. The asynchronous message is delivered via the normal events
- (<see cref="E:Npgsql.NpgsqlConnection.Notification"/>, <see cref="E:Npgsql.NpgsqlConnection.Notice"/>).
- </summary>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.TryGetBoundConnector(Npgsql.Internal.NpgsqlConnector@)">
- <summary>
- Checks whether the connection is currently bound to a connector, and if so, returns it via
- <paramref name="connector"/>.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.StartBindingScope(Npgsql.ConnectorBindingScope,Npgsql.Util.NpgsqlTimeout,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Binds this connection to a physical connector. This happens when opening a non-multiplexing connection,
- or when starting a transaction on a multiplexed connection.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.EndBindingScope(Npgsql.ConnectorBindingScope)">
- <summary>
- Ends binding scope to the physical connection and returns it to the pool. Only useful with multiplexing on.
- </summary>
- <remarks>
- After this method is called, under no circumstances the physical connection (connector) should ever be used if multiplexing is on.
- See #3249.
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.GetSchema">
- <summary>
- Returns the supported collections
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.GetSchema(System.String)">
- <summary>
- Returns the schema collection specified by the collection name.
- </summary>
- <param name="collectionName">The collection name.</param>
- <returns>The collection specified.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.GetSchema(System.String,System.String[])">
- <summary>
- Returns the schema collection specified by the collection name filtered by the restrictions.
- </summary>
- <param name="collectionName">The collection name.</param>
- <param name="restrictions">
- The restriction values to filter the results. A description of the restrictions is contained
- in the Restrictions collection.
- </param>
- <returns>The collection specified.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.GetSchemaAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously returns the supported collections.
- </summary>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>The collection specified.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.GetSchemaAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously returns the schema collection specified by the collection name.
- </summary>
- <param name="collectionName">The collection name.</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>The collection specified.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.GetSchemaAsync(System.String,System.String[],System.Threading.CancellationToken)">
- <summary>
- Asynchronously returns the schema collection specified by the collection name filtered by the restrictions.
- </summary>
- <param name="collectionName">The collection name.</param>
- <param name="restrictions">
- The restriction values to filter the results. A description of the restrictions is contained
- in the Restrictions collection.
- </param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>The collection specified.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.System#ICloneable#Clone">
- <summary>
- Creates a closed connection with the connection string and authentication details of this message.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.CloneWith(System.String)">
- <summary>
- Clones this connection, replacing its connection string with the given one.
- This allows creating a new connection with the same security information
- (password, SSL callbacks) while changing other connection parameters (e.g.
- database or pooling)
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.ChangeDatabase(System.String)">
- <summary>
- This method changes the current database by disconnecting from the actual
- database and connecting to the specified.
- </summary>
- <param name="dbName">The name of the database to use in place of the current database.</param>
- </member>
- <member name="P:Npgsql.NpgsqlConnection.DbProviderFactory">
- <summary>
- DB provider factory.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.ClearPool(Npgsql.NpgsqlConnection)">
- <summary>
- Clears the connection pool. All idle physical connections in the pool of the given connection are
- immediately closed, and any busy connections which were opened before <see cref="M:Npgsql.NpgsqlConnection.ClearPool(Npgsql.NpgsqlConnection)"/> was called
- will be closed when returned to the pool.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.ClearAllPools">
- <summary>
- Clear all connection pools. All idle physical connections in all pools are immediately closed, and any busy
- connections which were opened before <see cref="M:Npgsql.NpgsqlConnection.ClearAllPools"/> was called will be closed when returned
- to their pool.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.UnprepareAll">
- <summary>
- Unprepares all prepared statements on this connection.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnection.ReloadTypes">
- <summary>
- Flushes the type cache for this connection's connection string and reloads the types for this connection only.
- Type changes will appear for other connections only after they are re-opened from the pool.
- </summary>
- </member>
- <member name="E:Npgsql.NpgsqlConnection.Disposed">
- <summary>
- This event is unsupported by Npgsql. Use <see cref="E:System.Data.Common.DbConnection.StateChange"/> instead.
- </summary>
- </member>
- <member name="F:Npgsql.ConnectorBindingScope.None">
- <summary>
- The connection is currently not bound to a connector.
- </summary>
- </member>
- <member name="F:Npgsql.ConnectorBindingScope.Connection">
- <summary>
- The connection is bound to its connector for the scope of the entire connection
- (i.e. non-multiplexed connection).
- </summary>
- </member>
- <member name="F:Npgsql.ConnectorBindingScope.Transaction">
- <summary>
- The connection is bound to its connector for the scope of a transaction.
- </summary>
- </member>
- <member name="F:Npgsql.ConnectorBindingScope.Copy">
- <summary>
- The connection is bound to its connector for the scope of a COPY operation.
- </summary>
- </member>
- <member name="F:Npgsql.ConnectorBindingScope.Reader">
- <summary>
- The connection is bound to its connector for the scope of a single reader.
- </summary>
- </member>
- <member name="F:Npgsql.ConnectorBindingScope.Temporary">
- <summary>
- The connection is bound to its connector for an unspecified, temporary scope; the code that initiated
- the binding is also responsible to unbind it.
- </summary>
- </member>
- <member name="T:Npgsql.NoticeEventHandler">
- <summary>
- Represents a method that handles the <see cref="E:Npgsql.NpgsqlConnection.Notice"/> event.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:Npgsql.NpgsqlNoticeEventArgs"/> that contains the notice information (e.g. message, severity...).</param>
- </member>
- <member name="T:Npgsql.NotificationEventHandler">
- <summary>
- Represents a method that handles the <see cref="E:Npgsql.NpgsqlConnection.Notification"/> event.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:Npgsql.NpgsqlNotificationEventArgs"/> that contains the notification payload.</param>
- </member>
- <member name="T:Npgsql.ProvideClientCertificatesCallback">
- <summary>
- Represents a method that allows the application to provide a certificate collection to be used for SSL client authentication
- </summary>
- <param name="certificates">
- A <see cref="T:System.Security.Cryptography.X509Certificates.X509CertificateCollection"/> to be filled with one or more client
- certificates.
- </param>
- </member>
- <member name="T:Npgsql.ProvidePasswordCallback">
- <summary>
- Represents a method that allows the application to provide a password at connection time in code rather than configuration
- </summary>
- <param name="host">Hostname</param>
- <param name="port">Port</param>
- <param name="database">Database Name</param>
- <param name="username">User</param>
- <returns>A valid password for connecting to the database</returns>
- </member>
- <member name="T:Npgsql.PhysicalOpenCallback">
- <summary>
- Represents a method that allows the application to setup a connection with custom commands.
- </summary>
- <param name="connection">Physical connection to the database</param>
- </member>
- <member name="T:Npgsql.PhysicalOpenAsyncCallback">
- <summary>
- Represents an asynchronous method that allows the application to setup a connection with custom commands.
- </summary>
- <param name="connection">Physical connection to the database</param>
- </member>
- <member name="T:Npgsql.NpgsqlConnectionStringBuilder">
- <summary>
- Provides a simple way to create and manage the contents of connection strings used by
- the <see cref="T:Npgsql.NpgsqlConnection"/> class.
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlConnectionStringBuilder._dataSourceCached">
- <summary>
- Cached DataSource value to reduce allocations on NpgsqlConnection.DataSource.get
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnectionStringBuilder.#ctor">
- <summary>
- Initializes a new instance of the NpgsqlConnectionStringBuilder class.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnectionStringBuilder.#ctor(System.Boolean)">
- <summary>
- Initializes a new instance of the NpgsqlConnectionStringBuilder class, optionally using ODBC rules for quoting values.
- </summary>
- <param name="useOdbcRules">true to use {} to delimit fields; false to use quotation marks.</param>
- </member>
- <member name="M:Npgsql.NpgsqlConnectionStringBuilder.#ctor(System.String)">
- <summary>
- Initializes a new instance of the NpgsqlConnectionStringBuilder class and sets its <see cref="P:System.Data.Common.DbConnectionStringBuilder.ConnectionString"/>.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Item(System.String)">
- <summary>
- Gets or sets the value associated with the specified key.
- </summary>
- <param name="keyword">The key of the item to get or set.</param>
- <returns>The value associated with the specified key.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlConnectionStringBuilder.Add(System.Collections.Generic.KeyValuePair{System.String,System.Object})">
- <summary>
- Adds an item to the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/>.
- </summary>
- <param name="item">The key-value pair to be added.</param>
- </member>
- <member name="M:Npgsql.NpgsqlConnectionStringBuilder.Remove(System.String)">
- <summary>
- Removes the entry with the specified key from the DbConnectionStringBuilder instance.
- </summary>
- <param name="keyword">The key of the key/value pair to be removed from the connection string in this DbConnectionStringBuilder.</param>
- <returns><b>true</b> if the key existed within the connection string and was removed; <b>false</b> if the key did not exist.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlConnectionStringBuilder.Remove(System.Collections.Generic.KeyValuePair{System.String,System.Object})">
- <summary>
- Removes the entry from the DbConnectionStringBuilder instance.
- </summary>
- <param name="item">The key/value pair to be removed from the connection string in this DbConnectionStringBuilder.</param>
- <returns><b>true</b> if the key existed within the connection string and was removed; <b>false</b> if the key did not exist.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlConnectionStringBuilder.Clear">
- <summary>
- Clears the contents of the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/> instance.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnectionStringBuilder.ContainsKey(System.String)">
- <summary>
- Determines whether the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/> contains a specific key.
- </summary>
- <param name="keyword">The key to locate in the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/>.</param>
- <returns><b>true</b> if the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/> contains an entry with the specified key; otherwise <b>false</b>.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlConnectionStringBuilder.Contains(System.Collections.Generic.KeyValuePair{System.String,System.Object})">
- <summary>
- Determines whether the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/> contains a specific key-value pair.
- </summary>
- <param name="item">The item to locate in the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/>.</param>
- <returns><b>true</b> if the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/> contains the entry; otherwise <b>false</b>.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlConnectionStringBuilder.TryGetValue(System.String,System.Object@)">
- <summary>
- Retrieves a value corresponding to the supplied key from this <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/>.
- </summary>
- <param name="keyword">The key of the item to retrieve.</param>
- <param name="value">The value corresponding to the key.</param>
- <returns><b>true</b> if keyword was found within the connection string, <b>false</b> otherwise.</returns>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Host">
- <summary>
- The hostname or IP address of the PostgreSQL server to connect to.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Port">
- <summary>
- The TCP/IP port of the PostgreSQL server.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Database">
- <summary>
- The PostgreSQL database to connect to.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Username">
- <summary>
- The username to connect with. Not required if using IntegratedSecurity.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Password">
- <summary>
- The password to connect with. Not required if using IntegratedSecurity.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Passfile">
- <summary>
- Path to a PostgreSQL password file (PGPASSFILE), from which the password would be taken.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ApplicationName">
- <summary>
- The optional application name parameter to be sent to the backend during connection initiation.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Enlist">
- <summary>
- Whether to enlist in an ambient TransactionScope.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.SearchPath">
- <summary>
- Gets or sets the schema search path.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ClientEncoding">
- <summary>
- Gets or sets the client_encoding parameter.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Encoding">
- <summary>
- Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Timezone">
- <summary>
- Gets or sets the PostgreSQL session timezone, in Olson/IANA database format.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.SslMode">
- <summary>
- Controls whether SSL is required, disabled or preferred, depending on server support.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.TrustServerCertificate">
- <summary>
- Whether to trust the server certificate without validating it.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.SslCertificate">
- <summary>
- Location of a client certificate to be sent to the server.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.SslKey">
- <summary>
- Location of a client key for a client certificate to be sent to the server.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.SslPassword">
- <summary>
- Password for a key for a client certificate.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.RootCertificate">
- <summary>
- Location of a CA certificate used to validate the server certificate.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.CheckCertificateRevocation">
- <summary>
- Whether to check the certificate revocation list during authentication.
- False by default.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.IntegratedSecurity">
- <summary>
- Whether to use Windows integrated security to log in.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.KerberosServiceName">
- <summary>
- The Kerberos service name to be used for authentication.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.IncludeRealm">
- <summary>
- The Kerberos realm to be used for authentication.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.PersistSecurityInfo">
- <summary>
- Gets or sets a Boolean value that indicates if security-sensitive information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open state.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.LogParameters">
- <summary>
- When enabled, parameter values are logged when commands are executed. Defaults to false.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.IncludeErrorDetail">
- <summary>
- When enabled, PostgreSQL error details are included on <see cref="P:Npgsql.PostgresException.Detail" /> and
- <see cref="P:Npgsql.PostgresNotice.Detail" />. These can contain sensitive data.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Pooling">
- <summary>
- Whether connection pooling should be used.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.MinPoolSize">
- <summary>
- The minimum connection pool size.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.MaxPoolSize">
- <summary>
- The maximum connection pool size.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ConnectionIdleLifetime">
- <summary>
- The time to wait before closing idle connections in the pool if the count
- of all connections exceeds MinPoolSize.
- </summary>
- <value>The time (in seconds) to wait. The default value is 300.</value>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ConnectionPruningInterval">
- <summary>
- How many seconds the pool waits before attempting to prune idle connections that are beyond
- idle lifetime (<see cref="P:Npgsql.NpgsqlConnectionStringBuilder.ConnectionIdleLifetime"/>.
- </summary>
- <value>The interval (in seconds). The default value is 10.</value>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ConnectionLifetime">
- <summary>
- The total maximum lifetime of connections (in seconds). Connections which have exceeded this value will be
- destroyed instead of returned from the pool. This is useful in clustered configurations to force load
- balancing between a running server and a server just brought online.
- </summary>
- <value>The time (in seconds) to wait, or 0 to to make connections last indefinitely (the default).</value>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Timeout">
- <summary>
- The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error.
- Defaults to 15 seconds.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.CommandTimeout">
- <summary>
- The time to wait (in seconds) while trying to execute a command before terminating the attempt and generating an error.
- Defaults to 30 seconds.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.InternalCommandTimeout">
- <summary>
- The time to wait (in seconds) while trying to execute a an internal command before terminating the attempt and generating an error.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.CancellationTimeout">
- <summary>
- The time to wait (in milliseconds) while trying to read a response for a cancellation request for a timed out or cancelled query, before terminating the attempt and generating an error.
- Zero for infinity, -1 to skip the wait.
- Defaults to 2000 milliseconds.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.TargetSessionAttributes">
- <summary>
- Determines the preferred PostgreSQL target server type.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.LoadBalanceHosts">
- <summary>
- Enables balancing between multiple hosts by round-robin.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.HostRecheckSeconds">
- <summary>
- Controls for how long the host's cached state will be considered as valid.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.EntityTemplateDatabase">
- <summary>
- The database template to specify when creating a database in Entity Framework. If not specified,
- PostgreSQL defaults to "template1".
- </summary>
- <remarks>
- https://www.postgresql.org/docs/current/static/manage-ag-templatedbs.html
- </remarks>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.EntityAdminDatabase">
- <summary>
- The database admin to specify when creating and dropping a database in Entity Framework. This is needed because
- Npgsql needs to connect to a database in order to send the create/drop database command.
- If not specified, defaults to "template1". Check NpgsqlServices.UsingPostgresDBConnection for more information.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.KeepAlive">
- <summary>
- The number of seconds of connection inactivity before Npgsql sends a keepalive query.
- Set to 0 (the default) to disable.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.TcpKeepAlive">
- <summary>
- Whether to use TCP keepalive with system defaults if overrides isn't specified.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.TcpKeepAliveTime">
- <summary>
- The number of seconds of connection inactivity before a TCP keepalive query is sent.
- Use of this option is discouraged, use <see cref="P:Npgsql.NpgsqlConnectionStringBuilder.KeepAlive"/> instead if possible.
- Set to 0 (the default) to disable.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.TcpKeepAliveInterval">
- <summary>
- The interval, in seconds, between when successive keep-alive packets are sent if no acknowledgement is received.
- Defaults to the value of <see cref="P:Npgsql.NpgsqlConnectionStringBuilder.TcpKeepAliveTime"/>. <see cref="P:Npgsql.NpgsqlConnectionStringBuilder.TcpKeepAliveTime"/> must be non-zero as well.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ReadBufferSize">
- <summary>
- Determines the size of the internal buffer Npgsql uses when reading. Increasing may improve performance if transferring large values from the database.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.WriteBufferSize">
- <summary>
- Determines the size of the internal buffer Npgsql uses when writing. Increasing may improve performance if transferring large values to the database.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.SocketReceiveBufferSize">
- <summary>
- Determines the size of socket read buffer.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.SocketSendBufferSize">
- <summary>
- Determines the size of socket send buffer.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.MaxAutoPrepare">
- <summary>
- The maximum number SQL statements that can be automatically prepared at any given point.
- Beyond this number the least-recently-used statement will be recycled.
- Zero (the default) disables automatic preparation.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.AutoPrepareMinUsages">
- <summary>
- The minimum number of usages an SQL statement is used before it's automatically prepared.
- Defaults to 5.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.NoResetOnClose">
- <summary>
- If set to true, a pool connection's state won't be reset when it is closed (improves performance).
- Do not specify this unless you know what you're doing.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.LoadTableComposites">
- <summary>
- Load table composite type definitions, and not just free-standing composite types.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ReplicationMode">
- <summary>
- Set the replication mode of the connection
- </summary>
- <remarks>
- This property and its corresponding enum are intentionally kept internal as they
- should not be set by users or even be visible in their connection strings.
- Replication connections are a special kind of connection that is encapsulated in
- <see cref="T:Npgsql.Replication.PhysicalReplicationConnection"/>
- and <see cref="T:Npgsql.Replication.LogicalReplicationConnection"/>.
- </remarks>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Options">
- <summary>
- Set PostgreSQL configuration parameter default values for the connection.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ArrayNullabilityMode">
- <summary>
- Configure the way arrays of value types are returned when requested as object instances.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Multiplexing">
- <summary>
- Enables multiplexing, which allows more efficient use of connections.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.WriteCoalescingBufferThresholdBytes">
- <summary>
- When multiplexing is enabled, determines the maximum number of outgoing bytes to buffer before
- flushing to the network.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ServerCompatibilityMode">
- <summary>
- A compatibility mode for special PostgreSQL server types.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ConvertInfinityDateTime">
- <summary>
- Obsolete, see https://www.npgsql.org/doc/release-notes/6.0.html
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ContinuousProcessing">
- <summary>
- Obsolete, see https://www.npgsql.org/doc/release-notes/3.1.html
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.BackendTimeouts">
- <summary>
- Obsolete, see https://www.npgsql.org/doc/release-notes/3.1.html
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.PreloadReader">
- <summary>
- Obsolete, see https://www.npgsql.org/doc/release-notes/3.0.html
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.UseExtendedTypes">
- <summary>
- Obsolete, see https://www.npgsql.org/doc/release-notes/3.0.html
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.UseSslStream">
- <summary>
- Obsolete, see https://www.npgsql.org/doc/release-notes/4.1.html
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.UsePerfCounters">
- <summary>
- Writes connection performance information to performance counters.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ClientCertificate">
- <summary>
- Location of a client certificate to be sent to the server.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ClientCertificateKey">
- <summary>
- Key for a client certificate to be sent to the server.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.IncludeErrorDetails">
- <summary>
- When enabled, PostgreSQL error details are included on <see cref="P:Npgsql.PostgresException.Detail" /> and
- <see cref="P:Npgsql.PostgresNotice.Detail" />. These can contain sensitive data.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnectionStringBuilder.Equals(System.Object)">
- <summary>
- Determines whether the specified object is equal to the current object.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnectionStringBuilder.GetHashCode">
- <summary>
- Hash function.
- </summary>
- <returns></returns>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Keys">
- <summary>
- Gets an <see cref="T:System.Collections.ICollection" /> containing the keys of the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/>.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Values">
- <summary>
- Gets an <see cref="T:System.Collections.ICollection" /> containing the values in the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/>.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnectionStringBuilder.CopyTo(System.Collections.Generic.KeyValuePair{System.String,System.Object}[],System.Int32)">
- <summary>
- Copies the elements of the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/> to an Array, starting at a particular Array index.
- </summary>
- <param name="array">
- The one-dimensional Array that is the destination of the elements copied from <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/>.
- The Array must have zero-based indexing.
- </param>
- <param name="arrayIndex">
- The zero-based index in array at which copying begins.
- </param>
- </member>
- <member name="M:Npgsql.NpgsqlConnectionStringBuilder.GetEnumerator">
- <summary>
- Returns an enumerator that iterates through the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/>.
- </summary>
- <returns></returns>
- </member>
- <member name="M:Npgsql.NpgsqlConnectionStringBuilder.GetProperties(System.Collections.Hashtable)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.NpgsqlConnectionStringPropertyAttribute">
- <summary>
- Marks on <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/> which participate in the connection
- string. Optionally holds a set of synonyms for the property.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlConnectionStringPropertyAttribute.Synonyms">
- <summary>
- Holds a list of synonyms for the property.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnectionStringPropertyAttribute.#ctor">
- <summary>
- Creates a <see cref="T:Npgsql.NpgsqlConnectionStringPropertyAttribute"/>.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlConnectionStringPropertyAttribute.#ctor(System.String[])">
- <summary>
- Creates a <see cref="T:Npgsql.NpgsqlConnectionStringPropertyAttribute"/>.
- </summary>
- </member>
- <member name="T:Npgsql.ServerCompatibilityMode">
- <summary>
- An option specified in the connection string that activates special compatibility features.
- </summary>
- </member>
- <member name="F:Npgsql.ServerCompatibilityMode.None">
- <summary>
- No special server compatibility mode is active
- </summary>
- </member>
- <member name="F:Npgsql.ServerCompatibilityMode.Redshift">
- <summary>
- The server is an Amazon Redshift instance.
- </summary>
- </member>
- <member name="F:Npgsql.ServerCompatibilityMode.NoTypeLoading">
- <summary>
- The server is doesn't support full type loading from the PostgreSQL catalogs, support the basic set
- of types via information hardcoded inside Npgsql.
- </summary>
- </member>
- <member name="T:Npgsql.SslMode">
- <summary>
- Specifies how to manage SSL.
- </summary>
- </member>
- <member name="F:Npgsql.SslMode.Disable">
- <summary>
- SSL is disabled. If the server requires SSL, the connection will fail.
- </summary>
- </member>
- <member name="F:Npgsql.SslMode.Allow">
- <summary>
- Prefer non-SSL connections if the server allows them, but allow SSL connections.
- </summary>
- </member>
- <member name="F:Npgsql.SslMode.Prefer">
- <summary>
- Prefer SSL connections if the server allows them, but allow connections without SSL.
- </summary>
- </member>
- <member name="F:Npgsql.SslMode.Require">
- <summary>
- Fail the connection if the server doesn't support SSL.
- </summary>
- </member>
- <member name="F:Npgsql.SslMode.VerifyCA">
- <summary>
- Fail the connection if the server doesn't support SSL. Also verifies server certificate.
- </summary>
- </member>
- <member name="F:Npgsql.SslMode.VerifyFull">
- <summary>
- Fail the connection if the server doesn't support SSL. Also verifies server certificate with host's name.
- </summary>
- </member>
- <member name="T:Npgsql.ArrayNullabilityMode">
- <summary>
- Specifies how the mapping of arrays of
- <a href="https://docs.microsoft.com/dotnet/csharp/language-reference/builtin-types/value-types">value types</a>
- behaves with respect to nullability when they are requested via an API returning an <see cref="T:System.Object"/>.
- </summary>
- </member>
- <member name="F:Npgsql.ArrayNullabilityMode.Never">
- <summary>
- Arrays of value types are always returned as non-nullable arrays (e.g. <c>int[]</c>).
- If the PostgreSQL array contains a NULL value, an exception is thrown. This is the default mode.
- </summary>
- </member>
- <member name="F:Npgsql.ArrayNullabilityMode.Always">
- <summary>
- Arrays of value types are always returned as nullable arrays (e.g. <c>int?[]</c>).
- </summary>
- </member>
- <member name="F:Npgsql.ArrayNullabilityMode.PerInstance">
- <summary>
- The type of array that gets returned is determined at runtime.
- Arrays of value types are returned as non-nullable arrays (e.g. <c>int[]</c>)
- if the actual instance that gets returned doesn't contain null values
- and as nullable arrays (e.g. <c>int?[]</c>) if it does.
- </summary>
- <remarks>When using this setting, make sure that your code is prepared to the fact
- that the actual type of array instances returned from APIs like <see cref="M:Npgsql.NpgsqlDataReader.GetValue(System.Int32)"/>
- may change on a row by row base.</remarks>
- </member>
- <member name="T:Npgsql.ReplicationMode">
- <summary>
- Specifies whether the connection shall be initialized as a physical or
- logical replication connection
- </summary>
- <remarks>
- This enum and its corresponding property are intentionally kept internal as they
- should not be set by users or even be visible in their connection strings.
- Replication connections are a special kind of connection that is encapsulated in
- <see cref="T:Npgsql.Replication.PhysicalReplicationConnection"/>
- and <see cref="T:Npgsql.Replication.LogicalReplicationConnection"/>.
- </remarks>
- </member>
- <member name="F:Npgsql.ReplicationMode.Off">
- <summary>
- Replication disabled. This is the default
- </summary>
- </member>
- <member name="F:Npgsql.ReplicationMode.Physical">
- <summary>
- Physical replication enabled
- </summary>
- </member>
- <member name="F:Npgsql.ReplicationMode.Logical">
- <summary>
- Logical replication enabled
- </summary>
- </member>
- <member name="T:Npgsql.TargetSessionAttributes">
- <summary>
- Specifies server type preference.
- </summary>
- </member>
- <member name="F:Npgsql.TargetSessionAttributes.Any">
- <summary>
- Any successful connection is acceptable.
- </summary>
- </member>
- <member name="F:Npgsql.TargetSessionAttributes.ReadWrite">
- <summary>
- Session must accept read-write transactions by default (that is, the server must not be in hot standby mode and the
- <c>default_transaction_read_only</c> parameter must be off).
- </summary>
- </member>
- <member name="F:Npgsql.TargetSessionAttributes.ReadOnly">
- <summary>
- Session must not accept read-write transactions by default (the converse).
- </summary>
- </member>
- <member name="F:Npgsql.TargetSessionAttributes.Primary">
- <summary>
- Server must not be in hot standby mode.
- </summary>
- </member>
- <member name="F:Npgsql.TargetSessionAttributes.Standby">
- <summary>
- Server must be in hot standby mode.
- </summary>
- </member>
- <member name="F:Npgsql.TargetSessionAttributes.PreferPrimary">
- <summary>
- First try to find a primary server, but if none of the listed hosts is a primary server, try again in <see cref="F:Npgsql.TargetSessionAttributes.Any"/> mode.
- </summary>
- </member>
- <member name="F:Npgsql.TargetSessionAttributes.PreferStandby">
- <summary>
- First try to find a standby server, but if none of the listed hosts is a standby server, try again in <see cref="F:Npgsql.TargetSessionAttributes.Any"/> mode.
- </summary>
- </member>
- <member name="T:Npgsql.NpgsqlRowUpdatedEventHandler">
- <summary>
- Represents the method that handles the <see cref="E:Npgsql.NpgsqlDataAdapter.RowUpdated"/> events.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">An <see cref="T:Npgsql.NpgsqlRowUpdatedEventArgs"/> that contains the event data.</param>
- </member>
- <member name="T:Npgsql.NpgsqlRowUpdatingEventHandler">
- <summary>
- Represents the method that handles the <see cref="E:Npgsql.NpgsqlDataAdapter.RowUpdating"/> events.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">An <see cref="T:Npgsql.NpgsqlRowUpdatingEventArgs"/> that contains the event data.</param>
- </member>
- <member name="T:Npgsql.NpgsqlDataAdapter">
- <summary>
- This class represents an adapter from many commands: select, update, insert and delete to fill a <see cref="T:System.Data.DataSet"/>.
- </summary>
- </member>
- <member name="E:Npgsql.NpgsqlDataAdapter.RowUpdated">
- <summary>
- Row updated event.
- </summary>
- </member>
- <member name="E:Npgsql.NpgsqlDataAdapter.RowUpdating">
- <summary>
- Row updating event.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlDataAdapter.#ctor">
- <summary>
- Default constructor.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlDataAdapter.#ctor(Npgsql.NpgsqlCommand)">
- <summary>
- Constructor.
- </summary>
- <param name="selectCommand"></param>
- </member>
- <member name="M:Npgsql.NpgsqlDataAdapter.#ctor(System.String,Npgsql.NpgsqlConnection)">
- <summary>
- Constructor.
- </summary>
- <param name="selectCommandText"></param>
- <param name="selectConnection"></param>
- </member>
- <member name="M:Npgsql.NpgsqlDataAdapter.#ctor(System.String,System.String)">
- <summary>
- Constructor.
- </summary>
- <param name="selectCommandText"></param>
- <param name="selectConnectionString"></param>
- </member>
- <member name="M:Npgsql.NpgsqlDataAdapter.CreateRowUpdatedEvent(System.Data.DataRow,System.Data.IDbCommand,System.Data.StatementType,System.Data.Common.DataTableMapping)">
- <summary>
- Create row updated event.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlDataAdapter.CreateRowUpdatingEvent(System.Data.DataRow,System.Data.IDbCommand,System.Data.StatementType,System.Data.Common.DataTableMapping)">
- <summary>
- Create row updating event.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlDataAdapter.OnRowUpdated(System.Data.Common.RowUpdatedEventArgs)">
- <summary>
- Raise the RowUpdated event.
- </summary>
- <param name="value"></param>
- </member>
- <member name="M:Npgsql.NpgsqlDataAdapter.OnRowUpdating(System.Data.Common.RowUpdatingEventArgs)">
- <summary>
- Raise the RowUpdating event.
- </summary>
- <param name="value"></param>
- </member>
- <member name="P:Npgsql.NpgsqlDataAdapter.DeleteCommand">
- <summary>
- Delete command.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlDataAdapter.SelectCommand">
- <summary>
- Select command.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlDataAdapter.UpdateCommand">
- <summary>
- Update command.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlDataAdapter.InsertCommand">
- <summary>
- Insert command.
- </summary>
- </member>
- <member name="T:Npgsql.NpgsqlDataReader">
- <summary>
- Reads a forward-only stream of rows from a data source.
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlDataReader._behavior">
- <summary>
- The behavior of the command with which this reader was executed.
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlDataReader._sendTask">
- <summary>
- In multiplexing, this is <see langword="null" /> as the sending is managed in the write multiplexing loop,
- and does not need to be awaited by the reader.
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlDataReader._statements">
- <summary>
- Holds the list of statements being executed by this reader.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlDataReader.StatementIndex">
- <summary>
- The index of the current query resultset we're processing (within a multiquery)
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlDataReader._numColumns">
- <summary>
- The number of columns in the current row
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlDataReader._columns">
- <summary>
- Records, for each column, its starting offset and length in the current row.
- Used only in non-sequential mode.
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlDataReader._column">
- <summary>
- The index of the column that we're on, i.e. that has already been parsed, is
- is memory and can be retrieved. Initialized to -1, which means we're on the column
- count (which comes before the first column).
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlDataReader.ColumnLen">
- <summary>
- For streaming types (e.g. bytea), holds the byte length of the column.
- Does not include the length prefix.
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlDataReader._dataMsgEnd">
- <summary>
- The position in the buffer at which the current data row message ends.
- Used only when the row is consumed non-sequentially.
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlDataReader._canConsumeRowNonSequentially">
- <summary>
- Determines, if we can consume the row non-sequentially.
- Mostly useful for a sequential mode, when the row is already in the buffer.
- Should always be true for the non-sequential mode.
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlDataReader.RowDescription">
- <summary>
- The RowDescription message for the current resultset being processed
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlDataReader._hasRows">
- <summary>
- Whether the current result set has rows
- </summary>
- </member>
- <member name="E:Npgsql.NpgsqlDataReader.ReaderClosed">
- <summary>
- Is raised whenever Close() is called.
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlDataReader._columnStream">
- <summary>
- A stream that has been opened on a column.
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlDataReader._tempCharBuf">
- <summary>
- Used for internal temporary purposes
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlDataReader.UniqueRowId">
- <summary>
- Used to keep track of every unique row this reader object ever traverses.
- This is used to detect whether nested DbDataReaders are still valid.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.Read">
- <summary>
- Advances the reader to the next record in a result set.
- </summary>
- <returns><b>true</b> if there are more rows; otherwise <b>false</b>.</returns>
- <remarks>
- The default position of a data reader is before the first record. Therefore, you must call Read to begin accessing data.
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.ReadAsync(System.Threading.CancellationToken)">
- <summary>
- This is the asynchronous version of <see cref="M:Npgsql.NpgsqlDataReader.Read"/>
- </summary>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>A task representing the asynchronous operation.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.NextResult">
- <summary>
- Advances the reader to the next result when reading the results of a batch of statements.
- </summary>
- <returns></returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.NextResultAsync(System.Threading.CancellationToken)">
- <summary>
- This is the asynchronous version of NextResult.
- </summary>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>A task representing the asynchronous operation.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.NextResult(System.Boolean,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Internal implementation of NextResult
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.NextResultSchemaOnly(System.Boolean,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Note that in SchemaOnly mode there are no resultsets, and we read nothing from the backend (all
- RowDescriptions have already been processed and are available)
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlDataReader.Depth">
- <summary>
- Gets a value indicating the depth of nesting for the current row. Always returns zero.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlDataReader.IsClosed">
- <summary>
- Gets a value indicating whether the data reader is closed.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlDataReader.RecordsAffected">
- <summary>
- Gets the number of rows changed, inserted, or deleted by execution of the SQL statement.
- </summary>
- <value>
- The number of rows changed, inserted, or deleted. -1 for SELECT statements; 0 if no rows were affected or the statement failed.
- </value>
- </member>
- <member name="P:Npgsql.NpgsqlDataReader.Rows">
- <summary>
- Gets the number of rows changed, inserted, or deleted by execution of the SQL statement.
- </summary>
- <value>
- The number of rows changed, inserted, or deleted. 0 for SELECT statements, if no rows were affected or the statement failed.
- </value>
- </member>
- <member name="P:Npgsql.NpgsqlDataReader.Statements">
- <summary>
- Returns details about each statement that this reader will or has executed.
- </summary>
- <remarks>
- Note that some fields (i.e. rows and oid) are only populated as the reader
- traverses the result.
-
- For commands with multiple queries, this exposes the number of rows affected on
- a statement-by-statement basis, unlike <see cref="P:Npgsql.NpgsqlDataReader.RecordsAffected"/>
- which exposes an aggregation across all statements.
- </remarks>
- </member>
- <member name="P:Npgsql.NpgsqlDataReader.HasRows">
- <summary>
- Gets a value that indicates whether this DbDataReader contains one or more rows.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlDataReader.IsOnRow">
- <summary>
- Indicates whether the reader is currently positioned on a row, i.e. whether reading a
- column is possible.
- This property is different from <see cref="P:Npgsql.NpgsqlDataReader.HasRows"/> in that <see cref="P:Npgsql.NpgsqlDataReader.HasRows"/> will
- return true even if attempting to read a column will fail, e.g. before <see cref="M:Npgsql.NpgsqlDataReader.Read"/>
- has been called
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetName(System.Int32)">
- <summary>
- Gets the name of the column, given the zero-based column ordinal.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The name of the specified column.</returns>
- </member>
- <member name="P:Npgsql.NpgsqlDataReader.FieldCount">
- <summary>
- Gets the number of columns in the current row.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.Consume(System.Boolean)">
- <summary>
- Consumes all result sets for this reader, leaving the connector ready for sending and processing further
- queries
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.Dispose(System.Boolean)">
- <summary>
- Releases the resources used by the <see cref="T:Npgsql.NpgsqlDataReader"/>.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.DisposeAsync">
- <summary>
- Releases the resources used by the <see cref="T:Npgsql.NpgsqlDataReader"/>.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.Close">
- <summary>
- Closes the <see cref="T:Npgsql.NpgsqlDataReader"/> reader, allowing a new command to be executed.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.CloseAsync">
- <summary>
- Closes the <see cref="T:Npgsql.NpgsqlDataReader"/> reader, allowing a new command to be executed.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetBoolean(System.Int32)">
- <summary>
- Gets the value of the specified column as a Boolean.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The value of the specified column.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetByte(System.Int32)">
- <summary>
- Gets the value of the specified column as a byte.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The value of the specified column.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetChar(System.Int32)">
- <summary>
- Gets the value of the specified column as a single character.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The value of the specified column.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetInt16(System.Int32)">
- <summary>
- Gets the value of the specified column as a 16-bit signed integer.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The value of the specified column.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetInt32(System.Int32)">
- <summary>
- Gets the value of the specified column as a 32-bit signed integer.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The value of the specified column.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetInt64(System.Int32)">
- <summary>
- Gets the value of the specified column as a 64-bit signed integer.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The value of the specified column.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetDateTime(System.Int32)">
- <summary>
- Gets the value of the specified column as a <see cref="T:System.DateTime"/> object.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The value of the specified column.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetString(System.Int32)">
- <summary>
- Gets the value of the specified column as an instance of <see cref="T:System.String"/>.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The value of the specified column.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetDecimal(System.Int32)">
- <summary>
- Gets the value of the specified column as a <see cref="T:System.Decimal"/> object.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The value of the specified column.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetDouble(System.Int32)">
- <summary>
- Gets the value of the specified column as a double-precision floating point number.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The value of the specified column.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetFloat(System.Int32)">
- <summary>
- Gets the value of the specified column as a single-precision floating point number.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The value of the specified column.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetGuid(System.Int32)">
- <summary>
- Gets the value of the specified column as a globally-unique identifier (GUID).
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The value of the specified column.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetValues(System.Object[])">
- <summary>
- Populates an array of objects with the column values of the current row.
- </summary>
- <param name="values">An array of Object into which to copy the attribute columns.</param>
- <returns>The number of instances of <see cref="T:System.Object"/> in the array.</returns>
- </member>
- <member name="P:Npgsql.NpgsqlDataReader.Item(System.Int32)">
- <summary>
- Gets the value of the specified column as an instance of <see cref="T:System.Object"/>.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The value of the specified column.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetDate(System.Int32)">
- <summary>
- Gets the value of the specified column as an <see cref="T:NpgsqlTypes.NpgsqlDate"/>,
- Npgsql's provider-specific type for dates.
- </summary>
- <remarks>
- PostgreSQL's date type represents dates from 4713 BC to 5874897 AD, while .NET's DateTime
- only supports years from 1 to 1999. If you require years outside this range use this accessor.
- The standard <see cref="M:System.Data.Common.DbDataReader.GetProviderSpecificValue(System.Int32)"/> method will also return this type, but has
- the disadvantage of boxing the value.
- See https://www.postgresql.org/docs/current/static/datatype-datetime.html
- </remarks>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The value of the specified column.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetTimeSpan(System.Int32)">
- <summary>
- Gets the value of the specified column as a TimeSpan,
- </summary>
- <remarks>
- PostgreSQL's interval type has has a resolution of 1 microsecond and ranges from
- -178000000 to 178000000 years, while .NET's TimeSpan has a resolution of 100 nanoseconds
- and ranges from roughly -29247 to 29247 years.
- See https://www.postgresql.org/docs/current/static/datatype-datetime.html
- </remarks>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The value of the specified column.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetInterval(System.Int32)">
- <summary>
- Gets the value of the specified column as an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>,
- Npgsql's provider-specific type for time spans.
- </summary>
- <remarks>
- PostgreSQL's interval type has has a resolution of 1 microsecond and ranges from
- -178000000 to 178000000 years, while .NET's TimeSpan has a resolution of 100 nanoseconds
- and ranges from roughly -29247 to 29247 years. If you require values from outside TimeSpan's
- range use this accessor.
- The standard ADO.NET <see cref="M:System.Data.Common.DbDataReader.GetProviderSpecificValue(System.Int32)"/> method will also return this
- type, but has the disadvantage of boxing the value.
- See https://www.postgresql.org/docs/current/static/datatype-datetime.html
- </remarks>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The value of the specified column.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetTimeStamp(System.Int32)">
- <summary>
- Gets the value of the specified column as an <see cref="T:NpgsqlTypes.NpgsqlDateTime"/>,
- Npgsql's provider-specific type for date/time timestamps. Note that this type covers
- both PostgreSQL's "timestamp with time zone" and "timestamp without time zone" types,
- which differ only in how they are converted upon input/output.
- </summary>
- <remarks>
- PostgreSQL's timestamp type represents dates from 4713 BC to 5874897 AD, while .NET's DateTime
- only supports years from 1 to 1999. If you require years outside this range use this accessor.
- The standard <see cref="M:System.Data.Common.DbDataReader.GetProviderSpecificValue(System.Int32)"/> method will also return this type, but has
- the disadvantage of boxing the value.
- See https://www.postgresql.org/docs/current/static/datatype-datetime.html
- </remarks>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The value of the specified column.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetDbDataReader(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetData(System.Int32)">
- <summary>
- Returns a nested data reader for the requested column.
- The column type must be a record or a to Npgsql known composite type, or an array thereof.
- Currently only supported in non-sequential mode.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>A data reader.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)">
- <summary>
- Reads a stream of bytes from the specified column, starting at location indicated by dataOffset, into the buffer, starting at the location indicated by bufferOffset.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <param name="dataOffset">The index within the row from which to begin the read operation.</param>
- <param name="buffer">The buffer into which to copy the data.</param>
- <param name="bufferOffset">The index with the buffer to which the data will be copied.</param>
- <param name="length">The maximum number of characters to read.</param>
- <returns>The actual number of bytes read.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetStream(System.Int32)">
- <summary>
- Retrieves data as a <see cref="T:System.IO.Stream"/>.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The returned object.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetStreamAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Retrieves data as a <see cref="T:System.IO.Stream"/>.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>The returned object.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)">
- <summary>
- Reads a stream of characters from the specified column, starting at location indicated by dataOffset, into the buffer, starting at the location indicated by bufferOffset.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <param name="dataOffset">The index within the row from which to begin the read operation.</param>
- <param name="buffer">The buffer into which to copy the data.</param>
- <param name="bufferOffset">The index with the buffer to which the data will be copied.</param>
- <param name="length">The maximum number of characters to read.</param>
- <returns>The actual number of characters read.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetTextReader(System.Int32)">
- <summary>
- Retrieves data as a <see cref="T:System.IO.TextReader"/>.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The returned object.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetTextReaderAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Retrieves data as a <see cref="T:System.IO.TextReader"/>.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>The returned object.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetFieldValueAsync``1(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the value of the specified column as a type.
- </summary>
- <typeparam name="T">The type of the value to be returned.</typeparam>
- <param name="ordinal">The type of the value to be returned.</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns></returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetFieldValue``1(System.Int32)">
- <summary>
- Synchronously gets the value of the specified column as a type.
- </summary>
- <typeparam name="T">Synchronously gets the value of the specified column as a type.</typeparam>
- <param name="ordinal">The column to be retrieved.</param>
- <returns>The column to be retrieved.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetValue(System.Int32)">
- <summary>
- Gets the value of the specified column as an instance of <see cref="T:System.Object"/>.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The value of the specified column.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetProviderSpecificValue(System.Int32)">
- <summary>
- Gets the value of the specified column as an instance of <see cref="T:System.Object"/>.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The value of the specified column.</returns>
- </member>
- <member name="P:Npgsql.NpgsqlDataReader.Item(System.String)">
- <summary>
- Gets the value of the specified column as an instance of <see cref="T:System.Object"/>.
- </summary>
- <param name="name">The name of the column.</param>
- <returns>The value of the specified column.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.IsDBNull(System.Int32)">
- <summary>
- Gets a value that indicates whether the column contains nonexistent or missing values.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns><b>true</b> if the specified column is equivalent to <see cref="T:System.DBNull"/>; otherwise <b>false</b>.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.IsDBNullAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- An asynchronous version of <see cref="M:Npgsql.NpgsqlDataReader.IsDBNull(System.Int32)"/>, which gets a value that indicates whether the column contains non-existent or missing values.
- The <paramref name="cancellationToken"/> parameter is currently ignored.
- </summary>
- <param name="ordinal">The zero-based column to be retrieved.</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns><b>true</b> if the specified column value is equivalent to <see cref="T:System.DBNull"/> otherwise <b>false</b>.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetOrdinal(System.String)">
- <summary>
- Gets the column ordinal given the name of the column.
- </summary>
- <param name="name">The name of the column.</param>
- <returns>The zero-based column ordinal.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetPostgresType(System.Int32)">
- <summary>
- Gets a representation of the PostgreSQL data type for the specified field.
- The returned representation can be used to access various information about the field.
- </summary>
- <param name="ordinal">The zero-based column index.</param>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetDataTypeName(System.Int32)">
- <summary>
- Gets the data type information for the specified field.
- This is be the PostgreSQL type name (e.g. double precision), not the .NET type
- (see <see cref="M:Npgsql.NpgsqlDataReader.GetFieldType(System.Int32)"/> for that).
- </summary>
- <param name="ordinal">The zero-based column index.</param>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetDataTypeOID(System.Int32)">
- <summary>
- Gets the OID for the PostgreSQL type for the specified field, as it appears in the pg_type table.
- </summary>
- <remarks>
- This is a PostgreSQL-internal value that should not be relied upon and should only be used for
- debugging purposes.
- </remarks>
- <param name="ordinal">The zero-based column index.</param>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetFieldType(System.Int32)">
- <summary>
- Gets the data type of the specified column.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The data type of the specified column.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetProviderSpecificFieldType(System.Int32)">
- <summary>
- Returns the provider-specific field type of the specified column.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>The Type object that describes the data type of the specified column.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetProviderSpecificValues(System.Object[])">
- <summary>
- Gets all provider-specific attribute columns in the collection for the current row.
- </summary>
- <param name="values">An array of Object into which to copy the attribute columns.</param>
- <returns>The number of instances of <see cref="T:System.Object"/> in the array.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetEnumerator">
- <summary>
- Returns an <see cref="T:System.Collections.IEnumerator"/> that can be used to iterate through the rows in the data reader.
- </summary>
- <returns>An <see cref="T:System.Collections.IEnumerator"/> that can be used to iterate through the rows in the data reader.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetColumnSchema">
- <summary>
- Returns schema information for the columns in the current resultset.
- </summary>
- <returns></returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetColumnSchemaAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously returns schema information for the columns in the current resultset.
- </summary>
- <returns></returns>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetSchemaTable">
- <summary>
- Returns a System.Data.DataTable that describes the column metadata of the DataReader.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetSchemaTableAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously returns a System.Data.DataTable that describes the column metadata of the DataReader.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.SeekToColumnSequential(System.Int32,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Seeks to the given column. The 4-byte length is read and stored in <see cref="F:Npgsql.NpgsqlDataReader.ColumnLen"/>.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.GetField(System.Int32)">
- <summary>
- Checks that we have a RowDescription, but not necessary an actual resultset
- (for operations which work in SchemaOnly mode.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlDataReader.UnbindIfNecessary">
- <summary>
- Unbinds reader from the connector.
- Should be called before the connector is returned to the pool.
- </summary>
- </member>
- <member name="T:Npgsql.NpgsqlException">
- <summary>
- The exception that is thrown when server-related issues occur.
- </summary>
- <remarks>
- PostgreSQL errors (e.g. query SQL issues, constraint violations) are raised via
- <see cref="T:Npgsql.PostgresException"/> which is a subclass of this class.
- Purely Npgsql-related issues which aren't related to the server will be raised
- via the standard CLR exceptions (e.g. ArgumentException).
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.NpgsqlException"/> class.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.NpgsqlException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- <param name="innerException">The exception that is the cause of the current exception, or a null reference (<string>Nothing</string> in Visual Basic) if no inner exception is specified.</param>
- </member>
- <member name="M:Npgsql.NpgsqlException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.NpgsqlException"/> class with a specified error message.
- </summary>
- <param name="message">The message that describes the error.</param>
- </member>
- <member name="P:Npgsql.NpgsqlException.IsTransient">
- <summary>
- Specifies whether the exception is considered transient, that is, whether retrying the operation could
- succeed (e.g. a network error or a timeout).
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlException.BatchCommand">
- <summary>
- If the exception was thrown as a result of executing a <see cref="T:System.Data.Common.DbBatch"/>, references the <see cref="T:System.Data.Common.DbBatchCommand"/> within
- the batch which triggered the exception. Otherwise <see langword="null"/>.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.NpgsqlException"/> class with serialized data.
- </summary>
- <param name="info">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The StreamingContext that contains contextual information about the source or destination.</param>
- </member>
- <member name="T:Npgsql.NpgsqlFactory">
- <summary>
- A factory to create instances of various Npgsql objects.
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlFactory.Instance">
- <summary>
- Gets an instance of the <see cref="T:Npgsql.NpgsqlFactory"/>.
- This can be used to retrieve strongly typed data objects.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlFactory.CreateCommand">
- <summary>
- Returns a strongly typed <see cref="T:System.Data.Common.DbCommand"/> instance.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlFactory.CreateConnection">
- <summary>
- Returns a strongly typed <see cref="T:System.Data.Common.DbConnection"/> instance.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlFactory.CreateParameter">
- <summary>
- Returns a strongly typed <see cref="T:System.Data.Common.DbParameter"/> instance.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlFactory.CreateConnectionStringBuilder">
- <summary>
- Returns a strongly typed <see cref="T:System.Data.Common.DbConnectionStringBuilder"/> instance.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlFactory.CreateCommandBuilder">
- <summary>
- Returns a strongly typed <see cref="T:System.Data.Common.DbCommandBuilder"/> instance.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlFactory.CreateDataAdapter">
- <summary>
- Returns a strongly typed <see cref="T:System.Data.Common.DbDataAdapter"/> instance.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlFactory.CanCreateDataAdapter">
- <summary>
- Specifies whether the specific <see cref="T:System.Data.Common.DbProviderFactory"/> supports the <see cref="T:System.Data.Common.DbDataAdapter"/> class.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlFactory.CanCreateCommandBuilder">
- <summary>
- Specifies whether the specific <see cref="T:System.Data.Common.DbProviderFactory"/> supports the <see cref="T:System.Data.Common.DbCommandBuilder"/> class.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlFactory.GetService(System.Type)">
- <summary>
- Gets the service object of the specified type.
- </summary>
- <param name="serviceType">An object that specifies the type of service object to get.</param>
- <returns>A service object of type serviceType, or null if there is no service object of type serviceType.</returns>
- </member>
- <member name="T:Npgsql.NpgsqlLargeObjectManager">
- <summary>
- Large object manager. This class can be used to store very large files in a PostgreSQL database.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlLargeObjectManager.MaxTransferBlockSize">
- <summary>
- The largest chunk size (in bytes) read and write operations will read/write each roundtrip to the network. Default 4 MB.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectManager.#ctor(Npgsql.NpgsqlConnection)">
- <summary>
- Creates an NpgsqlLargeObjectManager for this connection. The connection must be opened to perform remote operations.
- </summary>
- <param name="connection"></param>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectManager.ExecuteFunction``1(System.String,System.Boolean,System.Threading.CancellationToken,System.Object[])">
- <summary>
- Execute a function
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectManager.ExecuteFunctionGetBytes(System.String,System.Byte[],System.Int32,System.Int32,System.Boolean,System.Threading.CancellationToken,System.Object[])">
- <summary>
- Execute a function that returns a byte array
- </summary>
- <returns></returns>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectManager.Create(System.UInt32)">
- <summary>
- Create an empty large object in the database. If an oid is specified but is already in use, an PostgresException will be thrown.
- </summary>
- <param name="preferredOid">A preferred oid, or specify 0 if one should be automatically assigned</param>
- <returns>The oid for the large object created</returns>
- <exception cref="T:Npgsql.PostgresException">If an oid is already in use</exception>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectManager.CreateAsync(System.UInt32,System.Threading.CancellationToken)">
- <summary>
- Create an empty large object in the database. If an oid is specified but is already in use, an PostgresException will be thrown.
- </summary>
- <param name="preferredOid">A preferred oid, or specify 0 if one should be automatically assigned</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>The oid for the large object created</returns>
- <exception cref="T:Npgsql.PostgresException">If an oid is already in use</exception>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectManager.OpenRead(System.UInt32)">
- <summary>
- Opens a large object on the backend, returning a stream controlling this remote object.
- A transaction snapshot is taken by the backend when the object is opened with only read permissions.
- When reading from this object, the contents reflects the time when the snapshot was taken.
- Note that this method, as well as operations on the stream must be wrapped inside a transaction.
- </summary>
- <param name="oid">Oid of the object</param>
- <returns>An NpgsqlLargeObjectStream</returns>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectManager.OpenReadAsync(System.UInt32,System.Threading.CancellationToken)">
- <summary>
- Opens a large object on the backend, returning a stream controlling this remote object.
- A transaction snapshot is taken by the backend when the object is opened with only read permissions.
- When reading from this object, the contents reflects the time when the snapshot was taken.
- Note that this method, as well as operations on the stream must be wrapped inside a transaction.
- </summary>
- <param name="oid">Oid of the object</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>An NpgsqlLargeObjectStream</returns>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectManager.OpenReadWrite(System.UInt32)">
- <summary>
- Opens a large object on the backend, returning a stream controlling this remote object.
- Note that this method, as well as operations on the stream must be wrapped inside a transaction.
- </summary>
- <param name="oid">Oid of the object</param>
- <returns>An NpgsqlLargeObjectStream</returns>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectManager.OpenReadWriteAsync(System.UInt32,System.Threading.CancellationToken)">
- <summary>
- Opens a large object on the backend, returning a stream controlling this remote object.
- Note that this method, as well as operations on the stream must be wrapped inside a transaction.
- </summary>
- <param name="oid">Oid of the object</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>An NpgsqlLargeObjectStream</returns>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectManager.Unlink(System.UInt32)">
- <summary>
- Deletes a large object on the backend.
- </summary>
- <param name="oid">Oid of the object to delete</param>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectManager.UnlinkAsync(System.UInt32,System.Threading.CancellationToken)">
- <summary>
- Deletes a large object on the backend.
- </summary>
- <param name="oid">Oid of the object to delete</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectManager.ExportRemote(System.UInt32,System.String)">
- <summary>
- Exports a large object stored in the database to a file on the backend. This requires superuser permissions.
- </summary>
- <param name="oid">Oid of the object to export</param>
- <param name="path">Path to write the file on the backend</param>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectManager.ExportRemoteAsync(System.UInt32,System.String,System.Threading.CancellationToken)">
- <summary>
- Exports a large object stored in the database to a file on the backend. This requires superuser permissions.
- </summary>
- <param name="oid">Oid of the object to export</param>
- <param name="path">Path to write the file on the backend</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectManager.ImportRemote(System.String,System.UInt32)">
- <summary>
- Imports a large object to be stored as a large object in the database from a file stored on the backend. This requires superuser permissions.
- </summary>
- <param name="path">Path to read the file on the backend</param>
- <param name="oid">A preferred oid, or specify 0 if one should be automatically assigned</param>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectManager.ImportRemoteAsync(System.String,System.UInt32,System.Threading.CancellationToken)">
- <summary>
- Imports a large object to be stored as a large object in the database from a file stored on the backend. This requires superuser permissions.
- </summary>
- <param name="path">Path to read the file on the backend</param>
- <param name="oid">A preferred oid, or specify 0 if one should be automatically assigned</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- </member>
- <member name="P:Npgsql.NpgsqlLargeObjectManager.Has64BitSupport">
- <summary>
- Since PostgreSQL 9.3, large objects larger than 2GB can be handled, up to 4TB.
- This property returns true whether the PostgreSQL version is >= 9.3.
- </summary>
- </member>
- <member name="T:Npgsql.NpgsqlLargeObjectStream">
- <summary>
- An interface to remotely control the seekable stream for an opened large object on a PostgreSQL server.
- Note that the OpenRead/OpenReadWrite method as well as all operations performed on this stream must be wrapped inside a database transaction.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlLargeObjectStream.Has64BitSupport">
- <summary>
- Since PostgreSQL 9.3, large objects larger than 2GB can be handled, up to 4TB.
- This property returns true whether the PostgreSQL version is >= 9.3.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectStream.Read(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Reads <i>count</i> bytes from the large object. The only case when fewer bytes are read is when end of stream is reached.
- </summary>
- <param name="buffer">The buffer where read data should be stored.</param>
- <param name="offset">The offset in the buffer where the first byte should be read.</param>
- <param name="count">The maximum number of bytes that should be read.</param>
- <returns>How many bytes actually read, or 0 if end of file was already reached.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads <i>count</i> bytes from the large object. The only case when fewer bytes are read is when end of stream is reached.
- </summary>
- <param name="buffer">The buffer where read data should be stored.</param>
- <param name="offset">The offset in the buffer where the first byte should be read.</param>
- <param name="count">The maximum number of bytes that should be read.</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>How many bytes actually read, or 0 if end of file was already reached.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectStream.Write(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Writes <i>count</i> bytes to the large object.
- </summary>
- <param name="buffer">The buffer to write data from.</param>
- <param name="offset">The offset in the buffer at which to begin copying bytes.</param>
- <param name="count">The number of bytes to write.</param>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Writes <i>count</i> bytes to the large object.
- </summary>
- <param name="buffer">The buffer to write data from.</param>
- <param name="offset">The offset in the buffer at which to begin copying bytes.</param>
- <param name="count">The number of bytes to write.</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- </member>
- <member name="P:Npgsql.NpgsqlLargeObjectStream.CanTimeout">
- <summary>
- CanTimeout always returns false.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlLargeObjectStream.CanRead">
- <summary>
- CanRead always returns true, unless the stream has been closed.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlLargeObjectStream.CanWrite">
- <summary>
- CanWrite returns true if the stream was opened with write permissions, and the stream has not been closed.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlLargeObjectStream.CanSeek">
- <summary>
- CanSeek always returns true, unless the stream has been closed.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlLargeObjectStream.Position">
- <summary>
- Returns the current position in the stream. Getting the current position does not need a round-trip to the server, however setting the current position does.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlLargeObjectStream.Length">
- <summary>
- Gets the length of the large object. This internally seeks to the end of the stream to retrieve the length, and then back again.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectStream.GetLengthAsync(System.Threading.CancellationToken)">
- <summary>
- Gets the length of the large object. This internally seeks to the end of the stream to retrieve the length, and then back again.
- </summary>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectStream.Seek(System.Int64,System.IO.SeekOrigin)">
- <summary>
- Seeks in the stream to the specified position. This requires a round-trip to the backend.
- </summary>
- <param name="offset">A byte offset relative to the <i>origin</i> parameter.</param>
- <param name="origin">A value of type SeekOrigin indicating the reference point used to obtain the new position.</param>
- <returns></returns>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectStream.SeekAsync(System.Int64,System.IO.SeekOrigin,System.Threading.CancellationToken)">
- <summary>
- Seeks in the stream to the specified position. This requires a round-trip to the backend.
- </summary>
- <param name="offset">A byte offset relative to the <i>origin</i> parameter.</param>
- <param name="origin">A value of type SeekOrigin indicating the reference point used to obtain the new position.</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectStream.Flush">
- <summary>
- Does nothing.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectStream.SetLength(System.Int64)">
- <summary>
- Truncates or enlarges the large object to the given size. If enlarging, the large object is extended with null bytes.
- For PostgreSQL versions earlier than 9.3, the value must fit in an Int32.
- </summary>
- <param name="value">Number of bytes to either truncate or enlarge the large object.</param>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectStream.SetLength(System.Int64,System.Threading.CancellationToken)">
- <summary>
- Truncates or enlarges the large object to the given size. If enlarging, the large object is extended with null bytes.
- For PostgreSQL versions earlier than 9.3, the value must fit in an Int32.
- </summary>
- <param name="value">Number of bytes to either truncate or enlarge the large object.</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectStream.Close">
- <summary>
- Releases resources at the backend allocated for this stream.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlLargeObjectStream.Dispose(System.Boolean)">
- <summary>
- Releases resources at the backend allocated for this stream, iff disposing is true.
- </summary>
- <param name="disposing">Whether to release resources allocated at the backend.</param>
- </member>
- <member name="T:Npgsql.NpgsqlNestedDataReader">
- <summary>
- Reads a forward-only stream of rows from a nested data source.
- Can be retrieved using <see cref="M:Npgsql.NpgsqlDataReader.GetData(System.Int32)"/> or
- <see cref="M:Npgsql.NpgsqlNestedDataReader.GetData(System.Int32)"/>.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlNestedDataReader.Item(System.Int32)">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlNestedDataReader.Item(System.String)">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlNestedDataReader.Depth">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlNestedDataReader.FieldCount">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlNestedDataReader.HasRows">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlNestedDataReader.IsClosed">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlNestedDataReader.RecordsAffected">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetBoolean(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetByte(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetChar(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetDateTime(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetDecimal(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetDouble(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetFloat(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetGuid(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetInt16(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetInt32(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetInt64(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetString(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetDbDataReader(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetData(System.Int32)">
- <summary>
- Returns a nested data reader for the requested column.
- The column type must be a record or a to Npgsql known composite type, or an array thereof.
- </summary>
- <param name="ordinal">The zero-based column ordinal.</param>
- <returns>A data reader.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetDataTypeName(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetEnumerator">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetName(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetOrdinal(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetFieldType(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetValue(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetValues(System.Object[])">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.IsDBNull(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetFieldValue``1(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetProviderSpecificFieldType(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetProviderSpecificValue(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.GetProviderSpecificValues(System.Object[])">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.Read">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.NextResult">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.Close">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlNestedDataReader.Dispose(System.Boolean)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.NpgsqlNotificationEventArgs">
- <summary>
- Provides information on a PostgreSQL notification. Notifications are sent when your connection has registered for
- notifications on a specific channel via the LISTEN command. NOTIFY can be used to generate such notifications,
- allowing for an inter-connection communication channel.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlNotificationEventArgs.PID">
- <summary>
- Process ID of the PostgreSQL backend that sent this notification.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlNotificationEventArgs.Channel">
- <summary>
- The channel on which the notification was sent.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlNotificationEventArgs.Payload">
- <summary>
- An optional payload string that was sent with this notification.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlNotificationEventArgs.Condition">
- <summary>
- The channel on which the notification was sent.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlNotificationEventArgs.AdditionalInformation">
- <summary>
- An optional payload string that was sent with this notification.
- </summary>
- </member>
- <member name="T:Npgsql.NpgsqlOperationInProgressException">
- <summary>
- Thrown when trying to use a connection that is already busy performing some other operation.
- Provides information on the already-executing operation to help with debugging.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlOperationInProgressException.#ctor(Npgsql.NpgsqlCommand)">
- <summary>
- Creates a new instance of <see cref="T:Npgsql.NpgsqlOperationInProgressException" />.
- </summary>
- <param name="command">
- A command which was in progress when the operation which triggered this exception was executed.
- </param>
- </member>
- <member name="P:Npgsql.NpgsqlOperationInProgressException.CommandInProgress">
- <summary>
- If the connection is busy with another command, this will contain a reference to that command.
- Otherwise, if the connection if busy with another type of operation (e.g. COPY), contains
- <see langword="null" />.
- </summary>
- </member>
- <member name="T:Npgsql.NpgsqlParameter">
- <summary>
- This class represents a parameter to a command that will be sent to server
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlParameter.ConvertedValue">
- <summary>
- Can be used to communicate a value from the validation phase to the writing phase.
- To be used by type handlers only.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlParameter.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter"/> class.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,System.Object)">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter"/> class with the parameter name and a value.
- </summary>
- <param name="parameterName">The name of the parameter to map.</param>
- <param name="value">The value of the <see cref="T:Npgsql.NpgsqlParameter"/>.</param>
- <remarks>
- <p>
- When you specify an <see cref="T:System.Object"/> in the value parameter, the <see cref="T:System.Data.DbType"/> is
- inferred from the CLR type.
- </p>
- <p>
- When using this constructor, you must be aware of a possible misuse of the constructor which takes a <see cref="P:Npgsql.NpgsqlParameter.DbType"/>
- parameter. This happens when calling this constructor passing an int 0 and the compiler thinks you are passing a value of
- <see cref="P:Npgsql.NpgsqlParameter.DbType"/>. Use <see cref="M:System.Convert.ToInt32(System.Object)"/> for example to have compiler calling the correct constructor.
- </p>
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,NpgsqlTypes.NpgsqlDbType)">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter"/> class with the parameter name and the data type.
- </summary>
- <param name="parameterName">The name of the parameter to map.</param>
- <param name="parameterType">One of the <see cref="T:NpgsqlTypes.NpgsqlDbType"/> values.</param>
- </member>
- <member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,System.Data.DbType)">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter"/>.
- </summary>
- <param name="parameterName">The name of the parameter to map.</param>
- <param name="parameterType">One of the <see cref="T:System.Data.DbType"/> values.</param>
- </member>
- <member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter"/>.
- </summary>
- <param name="parameterName">The name of the parameter to map.</param>
- <param name="parameterType">One of the <see cref="T:NpgsqlTypes.NpgsqlDbType"/> values.</param>
- <param name="size">The length of the parameter.</param>
- </member>
- <member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,System.Data.DbType,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter"/>.
- </summary>
- <param name="parameterName">The name of the parameter to map.</param>
- <param name="parameterType">One of the <see cref="T:System.Data.DbType"/> values.</param>
- <param name="size">The length of the parameter.</param>
- </member>
- <member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter"/>
- </summary>
- <param name="parameterName">The name of the parameter to map.</param>
- <param name="parameterType">One of the <see cref="T:NpgsqlTypes.NpgsqlDbType"/> values.</param>
- <param name="size">The length of the parameter.</param>
- <param name="sourceColumn">The name of the source column.</param>
- </member>
- <member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,System.Data.DbType,System.Int32,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter"/>.
- </summary>
- <param name="parameterName">The name of the parameter to map.</param>
- <param name="parameterType">One of the <see cref="T:System.Data.DbType"/> values.</param>
- <param name="size">The length of the parameter.</param>
- <param name="sourceColumn">The name of the source column.</param>
- </member>
- <member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32,System.String,System.Data.ParameterDirection,System.Boolean,System.Byte,System.Byte,System.Data.DataRowVersion,System.Object)">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter"/>.
- </summary>
- <param name="parameterName">The name of the parameter to map.</param>
- <param name="parameterType">One of the <see cref="T:NpgsqlTypes.NpgsqlDbType"/> values.</param>
- <param name="size">The length of the parameter.</param>
- <param name="sourceColumn">The name of the source column.</param>
- <param name="direction">One of the <see cref="T:System.Data.ParameterDirection"/> values.</param>
- <param name="isNullable">
- <see langword="true"/> if the value of the field can be <see langword="null"/>, otherwise <see langword="false"/>.
- </param>
- <param name="precision">
- The total number of digits to the left and right of the decimal point to which <see cref="P:Npgsql.NpgsqlParameter.Value"/> is resolved.
- </param>
- <param name="scale">The total number of decimal places to which <see cref="P:Npgsql.NpgsqlParameter.Value"/> is resolved.</param>
- <param name="sourceVersion">One of the <see cref="T:System.Data.DataRowVersion"/> values.</param>
- <param name="value">An <see cref="T:System.Object"/> that is the value of the <see cref="T:Npgsql.NpgsqlParameter"/>.</param>
- </member>
- <member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,System.Data.DbType,System.Int32,System.String,System.Data.ParameterDirection,System.Boolean,System.Byte,System.Byte,System.Data.DataRowVersion,System.Object)">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter"/>.
- </summary>
- <param name="parameterName">The name of the parameter to map.</param>
- <param name="parameterType">One of the <see cref="T:System.Data.DbType"/> values.</param>
- <param name="size">The length of the parameter.</param>
- <param name="sourceColumn">The name of the source column.</param>
- <param name="direction">One of the <see cref="T:System.Data.ParameterDirection"/> values.</param>
- <param name="isNullable">
- <see langword="true"/> if the value of the field can be <see langword="null"/>, otherwise <see langword="false"/>.
- </param>
- <param name="precision">
- The total number of digits to the left and right of the decimal point to which <see cref="P:Npgsql.NpgsqlParameter.Value"/> is resolved.
- </param>
- <param name="scale">The total number of decimal places to which <see cref="P:Npgsql.NpgsqlParameter.Value"/> is resolved.</param>
- <param name="sourceVersion">One of the <see cref="T:System.Data.DataRowVersion"/> values.</param>
- <param name="value">An <see cref="T:System.Object"/> that is the value of the <see cref="T:Npgsql.NpgsqlParameter"/>.</param>
- </member>
- <member name="P:Npgsql.NpgsqlParameter.ParameterName">
- <summary>
- Gets or sets The name of the <see cref="T:Npgsql.NpgsqlParameter"/>.
- </summary>
- <value>The name of the <see cref="T:Npgsql.NpgsqlParameter"/>.
- The default is an empty string.</value>
- </member>
- <member name="P:Npgsql.NpgsqlParameter.Value">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlParameter.NpgsqlValue">
- <summary>
- Gets or sets the value of the parameter.
- </summary>
- <value>
- An <see cref="T:System.Object" /> that is the value of the parameter.
- The default value is <see langword="null" />.
- </value>
- </member>
- <member name="P:Npgsql.NpgsqlParameter.DbType">
- <summary>
- Gets or sets the <see cref="T:System.Data.DbType"/> of the parameter.
- </summary>
- <value>One of the <see cref="T:System.Data.DbType"/> values. The default is <see cref="T:System.Object"/>.</value>
- </member>
- <member name="P:Npgsql.NpgsqlParameter.NpgsqlDbType">
- <summary>
- Gets or sets the <see cref="T:NpgsqlTypes.NpgsqlDbType"/> of the parameter.
- </summary>
- <value>One of the <see cref="T:NpgsqlTypes.NpgsqlDbType"/> values. The default is <see cref="T:NpgsqlTypes.NpgsqlDbType"/>.</value>
- </member>
- <member name="P:Npgsql.NpgsqlParameter.DataTypeName">
- <summary>
- Used to specify which PostgreSQL type will be sent to the database for this parameter.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlParameter.IsNullable">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlParameter.Direction">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlParameter.Precision">
- <summary>
- Gets or sets the maximum number of digits used to represent the <see cref="P:Npgsql.NpgsqlParameter.Value"/> property.
- </summary>
- <value>
- The maximum number of digits used to represent the <see cref="P:Npgsql.NpgsqlParameter.Value"/> property.
- The default value is 0, which indicates that the data provider sets the precision for <see cref="P:Npgsql.NpgsqlParameter.Value"/>.</value>
- </member>
- <member name="P:Npgsql.NpgsqlParameter.Scale">
- <summary>
- Gets or sets the number of decimal places to which <see cref="P:Npgsql.NpgsqlParameter.Value"/> is resolved.
- </summary>
- <value>The number of decimal places to which <see cref="P:Npgsql.NpgsqlParameter.Value"/> is resolved. The default is 0.</value>
- </member>
- <member name="P:Npgsql.NpgsqlParameter.Size">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlParameter.SourceColumn">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlParameter.SourceVersion">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlParameter.SourceColumnNullMapping">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlParameter.Collection">
- <summary>
- The collection to which this parameter belongs, if any.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlParameter.PostgresType">
- <summary>
- The PostgreSQL data type, such as int4 or text, as discovered from pg_type.
- This property is automatically set if parameters have been derived via
- <see cref="M:Npgsql.NpgsqlCommandBuilder.DeriveParameters(Npgsql.NpgsqlCommand)"/> and can be used to
- acquire additional information about the parameters' data type.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlParameter.ResetDbType">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlParameter.Clone">
- <summary>
- Creates a new <see cref="T:Npgsql.NpgsqlParameter"/> that is a copy of the current instance.
- </summary>
- <returns>A new <see cref="T:Npgsql.NpgsqlParameter"/> that is a copy of this instance.</returns>
- </member>
- <member name="T:Npgsql.NpgsqlParameterCollection">
- <summary>
- Represents a collection of parameters relevant to a <see cref="T:Npgsql.NpgsqlCommand"/> as well as their respective mappings to columns in
- a <see cref="T:System.Data.DataSet"/>.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.#ctor">
- <summary>
- Initializes a new instance of the NpgsqlParameterCollection class.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlParameterCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:Npgsql.NpgsqlParameter"/> with the specified name.
- </summary>
- <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter"/> to retrieve.</param>
- <value>
- The <see cref="T:Npgsql.NpgsqlParameter"/> with the specified name, or a <see langword="null"/> reference if the parameter is not found.
- </value>
- </member>
- <member name="P:Npgsql.NpgsqlParameterCollection.Item(System.Int32)">
- <summary>
- Gets the <see cref="T:Npgsql.NpgsqlParameter"/> at the specified index.
- </summary>
- <param name="index">The zero-based index of the <see cref="T:Npgsql.NpgsqlParameter"/> to retrieve.</param>
- <value>The <see cref="T:Npgsql.NpgsqlParameter"/> at the specified index.</value>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.Add(Npgsql.NpgsqlParameter)">
- <summary>
- Adds the specified <see cref="T:Npgsql.NpgsqlParameter"/> object to the <see cref="T:Npgsql.NpgsqlParameterCollection"/>.
- </summary>
- <param name="value">The <see cref="T:Npgsql.NpgsqlParameter"/> to add to the collection.</param>
- <returns>The index of the new <see cref="T:Npgsql.NpgsqlParameter"/> object.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.System#Collections#Generic#ICollection{Npgsql#NpgsqlParameter}#Add(Npgsql.NpgsqlParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.AddWithValue(System.String,System.Object)">
- <summary>
- Adds a <see cref="T:Npgsql.NpgsqlParameter"/> to the <see cref="T:Npgsql.NpgsqlParameterCollection"/> given the specified parameter name and
- value.
- </summary>
- <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter"/>.</param>
- <param name="value">The value of the <see cref="T:Npgsql.NpgsqlParameter"/> to add to the collection.</param>
- <returns>The parameter that was added.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.AddWithValue(System.String,NpgsqlTypes.NpgsqlDbType,System.Object)">
- <summary>
- Adds a <see cref="T:Npgsql.NpgsqlParameter"/> to the <see cref="T:Npgsql.NpgsqlParameterCollection"/> given the specified parameter name,
- data type and value.
- </summary>
- <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter"/>.</param>
- <param name="parameterType">One of the NpgsqlDbType values.</param>
- <param name="value">The value of the <see cref="T:Npgsql.NpgsqlParameter"/> to add to the collection.</param>
- <returns>The parameter that was added.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.AddWithValue(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32,System.Object)">
- <summary>
- Adds a <see cref="T:Npgsql.NpgsqlParameter"/> to the <see cref="T:Npgsql.NpgsqlParameterCollection"/> given the specified parameter name and
- value.
- </summary>
- <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter"/>.</param>
- <param name="value">The value of the <see cref="T:Npgsql.NpgsqlParameter"/> to add to the collection.</param>
- <param name="parameterType">One of the <see cref="T:NpgsqlTypes.NpgsqlDbType"/> values.</param>
- <param name="size">The length of the column.</param>
- <returns>The parameter that was added.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.AddWithValue(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32,System.String,System.Object)">
- <summary>
- Adds a <see cref="T:Npgsql.NpgsqlParameter"/> to the <see cref="T:Npgsql.NpgsqlParameterCollection"/> given the specified parameter name and
- value.
- </summary>
- <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter"/>.</param>
- <param name="value">The value of the <see cref="T:Npgsql.NpgsqlParameter"/> to add to the collection.</param>
- <param name="parameterType">One of the <see cref="T:NpgsqlTypes.NpgsqlDbType"/> values.</param>
- <param name="size">The length of the column.</param>
- <param name="sourceColumn">The name of the source column.</param>
- <returns>The parameter that was added.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.AddWithValue(System.Object)">
- <summary>
- Adds a <see cref="T:Npgsql.NpgsqlParameter"/> to the <see cref="T:Npgsql.NpgsqlParameterCollection"/> given the specified value.
- </summary>
- <param name="value">The value of the <see cref="T:Npgsql.NpgsqlParameter"/> to add to the collection.</param>
- <returns>The parameter that was added.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.AddWithValue(NpgsqlTypes.NpgsqlDbType,System.Object)">
- <summary>
- Adds a <see cref="T:Npgsql.NpgsqlParameter"/> to the <see cref="T:Npgsql.NpgsqlParameterCollection"/> given the specified data type and value.
- </summary>
- <param name="parameterType">One of the <see cref="T:NpgsqlTypes.NpgsqlDbType"/> values.</param>
- <param name="value">The value of the <see cref="T:Npgsql.NpgsqlParameter"/> to add to the collection.</param>
- <returns>The parameter that was added.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.Add(System.String,NpgsqlTypes.NpgsqlDbType)">
- <summary>
- Adds a <see cref="T:Npgsql.NpgsqlParameter"/> to the <see cref="T:Npgsql.NpgsqlParameterCollection"/> given the parameter name and the data type.
- </summary>
- <param name="parameterName">The name of the parameter.</param>
- <param name="parameterType">One of the <see cref="T:System.Data.DbType"/> values.</param>
- <returns>The index of the new <see cref="T:Npgsql.NpgsqlParameter"/> object.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.Add(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32)">
- <summary>
- Adds a <see cref="T:Npgsql.NpgsqlParameter"/> to the <see cref="T:Npgsql.NpgsqlParameterCollection"/> with the parameter name, the data type,
- and the column length.
- </summary>
- <param name="parameterName">The name of the parameter.</param>
- <param name="parameterType">One of the <see cref="T:System.Data.DbType"/> values.</param>
- <param name="size">The length of the column.</param>
- <returns>The index of the new <see cref="T:Npgsql.NpgsqlParameter"/> object.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.Add(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32,System.String)">
- <summary>
- Adds a <see cref="T:Npgsql.NpgsqlParameter"/> to the <see cref="T:Npgsql.NpgsqlParameterCollection"/> with the parameter name, the data type, the
- column length, and the source column name.
- </summary>
- <param name="parameterName">The name of the parameter.</param>
- <param name="parameterType">One of the <see cref="T:System.Data.DbType"/> values.</param>
- <param name="size">The length of the column.</param>
- <param name="sourceColumn">The name of the source column.</param>
- <returns>The index of the new <see cref="T:Npgsql.NpgsqlParameter"/> object.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.RemoveAt(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.Contains(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.IndexOf(System.String)">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlParameterCollection.IsReadOnly">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.RemoveAt(System.Int32)">
- <summary>
- Removes the specified <see cref="T:Npgsql.NpgsqlParameter"/> from the collection using a specific index.
- </summary>
- <param name="index">The zero-based index of the parameter.</param>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.Insert(System.Int32,System.Object)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.Remove(System.String)">
- <summary>
- Removes the specified <see cref="T:Npgsql.NpgsqlParameter"/> from the collection.
- </summary>
- <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter"/> to remove from the collection.</param>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.Remove(System.Object)">
- <summary>
- Removes the specified <see cref="T:Npgsql.NpgsqlParameter"/> from the collection.
- </summary>
- <param name="value">The <see cref="T:Npgsql.NpgsqlParameter"/> to remove from the collection.</param>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.Contains(System.Object)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.TryGetValue(System.String,Npgsql.NpgsqlParameter@)">
- <summary>
- Gets a value indicating whether a <see cref="T:Npgsql.NpgsqlParameter"/> with the specified parameter name exists in the collection.
- </summary>
- <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter"/> object to find.</param>
- <param name="parameter">
- A reference to the requested parameter is returned in this out param if it is found in the list.
- This value is <see langword="null"/> if the parameter is not found.
- </param>
- <returns>
- <see langword="true"/> if the collection contains the parameter and param will contain the parameter;
- otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.Clear">
- <summary>
- Removes all items from the collection.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.IndexOf(System.Object)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.Add(System.Object)">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlParameterCollection.IsFixedSize">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlParameterCollection.IsSynchronized">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlParameterCollection.Count">
- <summary>
- Gets the number of <see cref="T:Npgsql.NpgsqlParameter"/> objects in the collection.
- </summary>
- <value>The number of <see cref="T:Npgsql.NpgsqlParameter"/> objects in the collection.</value>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.CopyTo(System.Array,System.Int32)">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlParameterCollection.System#Collections#Generic#ICollection{Npgsql#NpgsqlParameter}#IsReadOnly">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.NpgsqlParameterCollection.SyncRoot">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.GetEnumerator">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.AddRange(System.Array)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.GetParameter(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.GetParameter(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.SetParameter(System.String,System.Data.Common.DbParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.SetParameter(System.Int32,System.Data.Common.DbParameter)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.IndexOf(Npgsql.NpgsqlParameter)">
- <summary>
- Report the offset within the collection of the given parameter.
- </summary>
- <param name="item">Parameter to find.</param>
- <returns>Index of the parameter, or -1 if the parameter is not present.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.Insert(System.Int32,Npgsql.NpgsqlParameter)">
- <summary>
- Insert the specified parameter into the collection.
- </summary>
- <param name="index">Index of the existing parameter before which to insert the new one.</param>
- <param name="item">Parameter to insert.</param>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.Contains(Npgsql.NpgsqlParameter)">
- <summary>
- Report whether the specified parameter is present in the collection.
- </summary>
- <param name="item">Parameter to find.</param>
- <returns>True if the parameter was found, otherwise false.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.Remove(Npgsql.NpgsqlParameter)">
- <summary>
- Remove the specified parameter from the collection.
- </summary>
- <param name="item">Parameter to remove.</param>
- <returns>True if the parameter was found and removed, otherwise false.</returns>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.CopyTo(Npgsql.NpgsqlParameter[],System.Int32)">
- <summary>
- Convert collection to a System.Array.
- </summary>
- <param name="array">Destination array.</param>
- <param name="arrayIndex">Starting index in destination array.</param>
- </member>
- <member name="M:Npgsql.NpgsqlParameterCollection.ToArray">
- <summary>
- Convert collection to a System.Array.
- </summary>
- <returns>NpgsqlParameter[]</returns>
- </member>
- <member name="F:Npgsql.PlaceholderType.NoParameters">
- <summary>
- The parameter collection includes no parameters.
- </summary>
- </member>
- <member name="F:Npgsql.PlaceholderType.Named">
- <summary>
- The parameter collection includes only named parameters.
- </summary>
- </member>
- <member name="F:Npgsql.PlaceholderType.Positional">
- <summary>
- The parameter collection includes only positional parameters.
- </summary>
- </member>
- <member name="F:Npgsql.PlaceholderType.Mixed">
- <summary>
- The parameter collection includes both named and positional parameters.
- This is only supported when <see cref="P:Npgsql.NpgsqlCommand.CommandType" /> is set to <see cref="F:System.Data.CommandType.StoredProcedure" />.
- </summary>
- </member>
- <member name="T:Npgsql.NpgsqlParameter`1">
- <summary>
- A generic version of <see cref="T:Npgsql.NpgsqlParameter"/> which provides more type safety and
- avoids boxing of value types. Use <see cref="P:Npgsql.NpgsqlParameter`1.TypedValue"/> instead of <see cref="P:Npgsql.NpgsqlParameter.Value"/>.
- </summary>
- <typeparam name="T">The type of the value that will be stored in the parameter.</typeparam>
- </member>
- <member name="P:Npgsql.NpgsqlParameter`1.TypedValue">
- <summary>
- Gets or sets the strongly-typed value of the parameter.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlParameter`1.Value">
- <summary>
- Gets or sets the value of the parameter. This delegates to <see cref="P:Npgsql.NpgsqlParameter`1.TypedValue"/>.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlParameter`1.#ctor">
- <summary>
- Initializes a new instance of <see cref="T:Npgsql.NpgsqlParameter`1" />.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlParameter`1.#ctor(System.String,`0)">
- <summary>
- Initializes a new instance of <see cref="T:Npgsql.NpgsqlParameter`1" /> with a parameter name and value.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlParameter`1.#ctor(System.String,NpgsqlTypes.NpgsqlDbType)">
- <summary>
- Initializes a new instance of <see cref="T:Npgsql.NpgsqlParameter`1" /> with a parameter name and type.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlParameter`1.#ctor(System.String,System.Data.DbType)">
- <summary>
- Initializes a new instance of <see cref="T:Npgsql.NpgsqlParameter`1" /> with a parameter name and type.
- </summary>
- </member>
- <member name="T:Npgsql.NpgsqlRawCopyStream">
- <summary>
- Provides an API for a raw binary COPY operation, a high-performance data import/export mechanism to
- a PostgreSQL table. Initiated by <see cref="M:Npgsql.NpgsqlConnection.BeginRawBinaryCopy(System.String)"/>
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/sql-copy.html.
- </remarks>
- </member>
- <member name="F:Npgsql.NpgsqlRawCopyStream.BinarySignature">
- <summary>
- The copy binary format header signature
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlRawCopyStream.Cancel">
- <summary>
- Cancels and terminates an ongoing operation. Any data already written will be discarded.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlRawCopyStream.CancelAsync">
- <summary>
- Cancels and terminates an ongoing operation. Any data already written will be discarded.
- </summary>
- </member>
- <member name="T:Npgsql.NpgsqlCopyTextWriter">
- <summary>
- Writer for a text import, initiated by <see cref="M:Npgsql.NpgsqlConnection.BeginTextImport(System.String)"/>.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/sql-copy.html.
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlCopyTextWriter.Cancel">
- <summary>
- Cancels and terminates an ongoing import. Any data already written will be discarded.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlCopyTextWriter.CancelAsync">
- <summary>
- Cancels and terminates an ongoing import. Any data already written will be discarded.
- </summary>
- </member>
- <member name="T:Npgsql.NpgsqlCopyTextReader">
- <summary>
- Reader for a text export, initiated by <see cref="M:Npgsql.NpgsqlConnection.BeginTextExport(System.String)"/>.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/sql-copy.html.
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlCopyTextReader.Cancel">
- <summary>
- Cancels and terminates an ongoing export.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlCopyTextReader.CancelAsync">
- <summary>
- Asynchronously cancels and terminates an ongoing export.
- </summary>
- </member>
- <member name="T:Npgsql.NpgsqlSchema">
- <summary>
- Provides the underlying mechanism for reading schema information.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlSchema.GetMetaDataCollections">
- <summary>
- Returns the MetaDataCollections that lists all possible collections.
- </summary>
- <returns>The MetaDataCollections</returns>
- </member>
- <member name="M:Npgsql.NpgsqlSchema.GetRestrictions">
- <summary>
- Returns the Restrictions that contains the meaning and position of the values in the restrictions array.
- </summary>
- <returns>The Restrictions</returns>
- </member>
- <member name="M:Npgsql.NpgsqlSchema.PopulateDefaultDataTypeInfo(System.Data.DataRow,Npgsql.PostgresTypes.PostgresType)">
- <summary>
- Populates some generic type information that is common for base types, arrays, enums, etc. Some will
- be overridden later.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlSchema.PopulateHardcodedDataTypeInfo(System.Data.DataRow,Npgsql.PostgresTypes.PostgresType)">
- <summary>
- Sets some custom, hardcoded info on a DataType row that cannot be loaded/inferred from PostgreSQL
- </summary>
- </member>
- <member name="F:Npgsql.NpgsqlSchema.ReservedKeywords">
- <summary>
- List of keywords taken from PostgreSQL 9.0 reserved words documentation.
- </summary>
- </member>
- <member name="T:Npgsql.NpgsqlTracingOptions">
- <summary>
- Options to configure Npgsql's support for OpenTelemetry tracing.
- Currently no options are available.
- </summary>
- </member>
- <member name="T:Npgsql.NpgsqlTransaction">
- <summary>
- Represents a transaction to be made in a PostgreSQL database. This class cannot be inherited.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlTransaction.Connection">
- <summary>
- Specifies the <see cref="T:Npgsql.NpgsqlConnection"/> object associated with the transaction.
- </summary>
- <value>The <see cref="T:Npgsql.NpgsqlConnection"/> object associated with the transaction.</value>
- </member>
- <member name="P:Npgsql.NpgsqlTransaction.DbConnection">
- <summary>
- Specifies the <see cref="T:Npgsql.NpgsqlConnection"/> object associated with the transaction.
- </summary>
- <value>The <see cref="T:Npgsql.NpgsqlConnection"/> object associated with the transaction.</value>
- </member>
- <member name="P:Npgsql.NpgsqlTransaction.IsCompleted">
- <summary>
- If true, the transaction has been committed/rolled back, but not disposed.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlTransaction.IsolationLevel">
- <summary>
- Specifies the isolation level for this transaction.
- </summary>
- <value>The isolation level for this transaction. The default is <see cref="F:System.Data.IsolationLevel.ReadCommitted"/>.</value>
- </member>
- <member name="M:Npgsql.NpgsqlTransaction.Commit">
- <summary>
- Commits the database transaction.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlTransaction.CommitAsync(System.Threading.CancellationToken)">
- <summary>
- Commits the database transaction.
- </summary>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- </member>
- <member name="M:Npgsql.NpgsqlTransaction.Rollback">
- <summary>
- Rolls back a transaction from a pending state.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlTransaction.RollbackAsync(System.Threading.CancellationToken)">
- <summary>
- Rolls back a transaction from a pending state.
- </summary>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- </member>
- <member name="M:Npgsql.NpgsqlTransaction.Save(System.String)">
- <summary>
- Creates a transaction save point.
- </summary>
- <param name="name">The name of the savepoint.</param>
- <remarks>
- This method does not cause a database roundtrip to be made. The savepoint creation statement will instead be sent along with
- the next command.
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlTransaction.SaveAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Creates a transaction save point.
- </summary>
- <param name="name">The name of the savepoint.</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <remarks>
- This method does not cause a database roundtrip to be made, and will therefore always complete synchronously.
- The savepoint creation statement will instead be sent along with the next command.
- </remarks>
- </member>
- <member name="M:Npgsql.NpgsqlTransaction.Rollback(System.String)">
- <summary>
- Rolls back a transaction from a pending savepoint state.
- </summary>
- <param name="name">The name of the savepoint.</param>
- </member>
- <member name="M:Npgsql.NpgsqlTransaction.RollbackAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Rolls back a transaction from a pending savepoint state.
- </summary>
- <param name="name">The name of the savepoint.</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- </member>
- <member name="M:Npgsql.NpgsqlTransaction.Release(System.String)">
- <summary>
- Releases a transaction from a pending savepoint state.
- </summary>
- <param name="name">The name of the savepoint.</param>
- </member>
- <member name="M:Npgsql.NpgsqlTransaction.ReleaseAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Releases a transaction from a pending savepoint state.
- </summary>
- <param name="name">The name of the savepoint.</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- </member>
- <member name="M:Npgsql.NpgsqlTransaction.Dispose(System.Boolean)">
- <summary>
- Disposes the transaction, rolling it back if it is still pending.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlTransaction.DisposeAsync">
- <summary>
- Disposes the transaction, rolling it back if it is still pending.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlTransaction.DisposeImmediately(System.Exception)">
- <summary>
- Disposes the transaction, without rolling back. Used only in special circumstances, e.g. when
- the connection is broken.
- </summary>
- </member>
- <member name="M:Npgsql.NpgsqlTransaction.UnbindIfNecessary">
- <summary>
- Unbinds transaction from the connector.
- Should be called before the connector is returned to the pool.
- </summary>
- </member>
- <member name="T:Npgsql.PgPassFile">
- <summary>
- Represents a .pgpass file, which contains passwords for noninteractive connections
- </summary>
- </member>
- <member name="P:Npgsql.PgPassFile.FileName">
- <summary>
- File name being parsed for credentials
- </summary>
- </member>
- <member name="M:Npgsql.PgPassFile.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.PgPassFile"/> class
- </summary>
- <param name="fileName"></param>
- </member>
- <member name="P:Npgsql.PgPassFile.Entries">
- <summary>
- Parses file content and gets all credentials from the file
- </summary>
- <returns><see cref="T:System.Collections.Generic.IEnumerable`1"/> corresponding to all lines in the .pgpass file</returns>
- </member>
- <member name="M:Npgsql.PgPassFile.GetFirstMatchingEntry(System.String,System.Nullable{System.Int32},System.String,System.String)">
- <summary>
- Searches queries loaded from .PGPASS file to find first entry matching the provided parameters.
- </summary>
- <param name="host">Hostname to query. Use null to match any.</param>
- <param name="port">Port to query. Use null to match any.</param>
- <param name="database">Database to query. Use null to match any.</param>
- <param name="username">User name to query. Use null to match any.</param>
- <returns>Matching <see cref="T:Npgsql.PgPassFile.Entry"/> if match was found. Otherwise, returns null.</returns>
- </member>
- <member name="T:Npgsql.PgPassFile.Entry">
- <summary>
- Represents a hostname, port, database, username, and password combination that has been retrieved from a .pgpass file
- </summary>
- </member>
- <member name="P:Npgsql.PgPassFile.Entry.Host">
- <summary>
- Hostname parsed from the .pgpass file
- </summary>
- </member>
- <member name="P:Npgsql.PgPassFile.Entry.Port">
- <summary>
- Port parsed from the .pgpass file
- </summary>
- </member>
- <member name="P:Npgsql.PgPassFile.Entry.Database">
- <summary>
- Database parsed from the .pgpass file
- </summary>
- </member>
- <member name="P:Npgsql.PgPassFile.Entry.Username">
- <summary>
- User name parsed from the .pgpass file
- </summary>
- </member>
- <member name="P:Npgsql.PgPassFile.Entry.Password">
- <summary>
- Password parsed from the .pgpass file
- </summary>
- </member>
- <member name="M:Npgsql.PgPassFile.Entry.#ctor(System.String,System.Nullable{System.Int32},System.String,System.String,System.String)">
- <summary>
- This class represents an entry from the .pgpass file
- </summary>
- <param name="host">Hostname parsed from the .pgpass file</param>
- <param name="port">Port parsed from the .pgpass file</param>
- <param name="database">Database parsed from the .pgpass file</param>
- <param name="username">User name parsed from the .pgpass file</param>
- <param name="password">Password parsed from the .pgpass file</param>
- </member>
- <member name="M:Npgsql.PgPassFile.Entry.Parse(System.String)">
- <summary>
- Creates new <see cref="T:Npgsql.PgPassFile.Entry"/> based on string in the format hostname:port:database:username:password. The : and \ characters should be escaped with a \.
- </summary>
- <param name="serializedEntry">string for the entry from the pgpass file</param>
- <returns>New instance of <see cref="T:Npgsql.PgPassFile.Entry"/> for the string</returns>
- <exception cref="T:System.FormatException">Entry is not formatted as hostname:port:database:username:password or non-wildcard port is not a number</exception>
- </member>
- <member name="M:Npgsql.PgPassFile.Entry.IsMatch(System.String,System.Nullable{System.Int32},System.String,System.String)">
- <summary>
- Checks whether this <see cref="T:Npgsql.PgPassFile.Entry"/> matches the parameters supplied
- </summary>
- <param name="host">Hostname to check against this entry</param>
- <param name="port">Port to check against this entry</param>
- <param name="database">Database to check against this entry</param>
- <param name="username">Username to check against this entry</param>
- <returns>True if the entry is a match. False otherwise.</returns>
- </member>
- <member name="M:Npgsql.PgPassFile.Entry.AreValuesMatched(System.String,System.String)">
- <summary>
- Checks if 2 strings are a match for a <see cref="T:Npgsql.PgPassFile.Entry"/> considering that either value can be a wildcard (*)
- </summary>
- <param name="query">Value being searched</param>
- <param name="actual">Value from the PGPASS entry</param>
- <returns>True if the values are a match. False otherwise.</returns>
- </member>
- <member name="T:Npgsql.PoolManager">
- <summary>
- Provides lookup for a pool based on a connection string.
- </summary>
- <remarks>
- <see cref="M:Npgsql.PoolManager.TryGetValue(System.String,Npgsql.ConnectorSource@)"/> is lock-free, to avoid contention, but the same isn't
- true of <see cref="M:Npgsql.PoolManager.GetOrAdd(System.String,Npgsql.ConnectorSource)"/>, which acquires a lock. The calling code always tries
- <see cref="M:Npgsql.PoolManager.TryGetValue(System.String,Npgsql.ConnectorSource@)"/> before trying to <see cref="M:Npgsql.PoolManager.GetOrAdd(System.String,Npgsql.ConnectorSource)"/>.
- </remarks>
- </member>
- <member name="M:Npgsql.PoolManager.Reset">
- <summary>
- Resets the pool manager to its initial state, for test purposes only.
- Assumes that no other threads are accessing the pool.
- </summary>
- </member>
- <member name="T:Npgsql.PostgresDatabaseInfoFactory">
- <summary>
- The default implementation of <see cref="T:Npgsql.Internal.INpgsqlDatabaseInfoFactory"/>, for standard PostgreSQL databases..
- </summary>
- </member>
- <member name="M:Npgsql.PostgresDatabaseInfoFactory.Load(Npgsql.Internal.NpgsqlConnector,Npgsql.Util.NpgsqlTimeout,System.Boolean)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.PostgresDatabaseInfo">
- <summary>
- The default implementation of NpgsqlDatabase, for standard PostgreSQL databases.
- </summary>
- </member>
- <member name="F:Npgsql.PostgresDatabaseInfo.Log">
- <summary>
- The Npgsql logger instance.
- </summary>
- </member>
- <member name="F:Npgsql.PostgresDatabaseInfo._types">
- <summary>
- The PostgreSQL types detected in the database.
- </summary>
- </member>
- <member name="M:Npgsql.PostgresDatabaseInfo.GetTypes">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.PostgresDatabaseInfo.LongVersion">
- <summary>
- The PostgreSQL version string as returned by the version() function. Populated during loading.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresDatabaseInfo.IsRedshift">
- <summary>
- True if the backend is Amazon Redshift; otherwise, false.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresDatabaseInfo.SupportsUnlisten">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.PostgresDatabaseInfo.HasEnumSortOrder">
- <summary>
- True if the 'pg_enum' table includes the 'enumsortorder' column; otherwise, false.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresDatabaseInfo.HasTypeCategory">
- <summary>
- True if the 'pg_type' table includes the 'typcategory' column; otherwise, false.
- </summary>
- <remarks>
- pg_type.typcategory is added after 8.4.
- see: https://www.postgresql.org/docs/8.4/static/catalog-pg-type.html#CATALOG-TYPCATEGORY-TABLE
- </remarks>
- </member>
- <member name="M:Npgsql.PostgresDatabaseInfo.LoadPostgresInfo(Npgsql.Internal.NpgsqlConnector,Npgsql.Util.NpgsqlTimeout,System.Boolean)">
- <summary>
- Loads database information from the PostgreSQL database specified by <paramref name="conn"/>.
- </summary>
- <param name="conn">The database connection.</param>
- <param name="timeout">The timeout while loading types from the backend.</param>
- <param name="async">True to load types asynchronously.</param>
- <returns>
- A task representing the asynchronous operation.
- </returns>
- </member>
- <member name="M:Npgsql.PostgresDatabaseInfo.GenerateLoadTypesQuery(System.Boolean,System.Boolean,System.Boolean)">
- <summary>
- Generates a raw SQL query string to select type information.
- </summary>
- <remarks>
- Select all types (base, array which is also base, enum, range, composite).
- Note that arrays are distinguished from primitive types through them having typreceive=array_recv.
- Order by primitives first, container later.
- For arrays and ranges, join in the element OID and type (to filter out arrays of unhandled
- types).
- </remarks>
- </member>
- <member name="M:Npgsql.PostgresDatabaseInfo.LoadBackendTypes(Npgsql.Internal.NpgsqlConnector,Npgsql.Util.NpgsqlTimeout,System.Boolean)">
- <summary>
- Loads type information from the backend specified by <paramref name="conn"/>.
- </summary>
- <param name="conn">The database connection.</param>
- <param name="timeout">The timeout while loading types from the backend.</param>
- <param name="async">True to load types asynchronously.</param>
- <returns>
- A collection of types loaded from the backend.
- </returns>
- <exception cref="T:System.TimeoutException" />
- <exception cref="T:System.ArgumentOutOfRangeException">Unknown typtype for type '{internalName}' in pg_type: {typeChar}.</exception>
- </member>
- <member name="T:Npgsql.PostgresErrorCodes">
- <summary>
- Provides constants for PostgreSQL error codes.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/errcodes-appendix.html
- </remarks>
- </member>
- <member name="T:Npgsql.PostgresException">
- <summary>
- The exception that is thrown when the PostgreSQL backend reports errors (e.g. query
- SQL issues, constraint violations).
- </summary>
- <remarks>
- This exception only corresponds to a PostgreSQL-delivered error.
- Other errors (e.g. network issues) will be raised via <see cref="T:Npgsql.NpgsqlException" />,
- and purely Npgsql-related issues which aren't related to the server will be raised
- via the standard CLR exceptions (e.g. <see cref="T:System.ArgumentException" />).
-
- See https://www.postgresql.org/docs/current/static/errcodes-appendix.html,
- https://www.postgresql.org/docs/current/static/protocol-error-fields.html
- </remarks>
- </member>
- <member name="M:Npgsql.PostgresException.#ctor(System.String,System.String,System.String,System.String)">
- <summary>
- Creates a new instance.
- </summary>
- </member>
- <member name="M:Npgsql.PostgresException.#ctor(System.String,System.String,System.String,System.String,System.String,System.String,System.Int32,System.Int32,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String)">
- <summary>
- Creates a new instance.
- </summary>
- </member>
- <member name="M:Npgsql.PostgresException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with the data needed to serialize the target object.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param>
- <param name="context">The destination (see <see cref="T:System.Runtime.Serialization.StreamingContext"/>) for this serialization.</param>
- </member>
- <member name="M:Npgsql.PostgresException.ToString">
- <inheritdoc />
- </member>
- <member name="P:Npgsql.PostgresException.IsTransient">
- <summary>
- Specifies whether the exception is considered transient, that is, whether retrying the operation could
- succeed (e.g. a network error). Check <see cref="P:Npgsql.PostgresException.SqlState"/>.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresException.Severity">
- <summary>
- Severity of the error or notice.
- Always present.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresException.InvariantSeverity">
- <summary>
- Severity of the error or notice, not localized.
- Always present since PostgreSQL 9.6.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresException.SqlState">
- <summary>
- The SQLSTATE code for the error.
- </summary>
- <remarks>
- Always present.
- Constants are defined in <seealso cref="T:Npgsql.PostgresErrorCodes"/>.
- See https://www.postgresql.org/docs/current/static/errcodes-appendix.html
- </remarks>
- </member>
- <member name="P:Npgsql.PostgresException.Code">
- <summary>
- The SQLSTATE code for the error.
- </summary>
- <remarks>
- Always present.
- Constants are defined in <seealso cref="T:Npgsql.PostgresErrorCodes"/>.
- See https://www.postgresql.org/docs/current/static/errcodes-appendix.html
- </remarks>
- </member>
- <member name="P:Npgsql.PostgresException.MessageText">
- <summary>
- The primary human-readable error message. This should be accurate but terse.
- </summary>
- <remarks>
- Always present.
- </remarks>
- </member>
- <member name="P:Npgsql.PostgresException.Detail">
- <summary>
- An optional secondary error message carrying more detail about the problem.
- May run to multiple lines.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresException.Hint">
- <summary>
- An optional suggestion what to do about the problem.
- This is intended to differ from Detail in that it offers advice (potentially inappropriate) rather than hard facts.
- May run to multiple lines.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresException.Position">
- <summary>
- The field value is a decimal ASCII integer, indicating an error cursor position as an index into the original query string.
- The first character has index 1, and positions are measured in characters not bytes.
- 0 means not provided.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresException.InternalPosition">
- <summary>
- This is defined the same as the <see cref="P:Npgsql.PostgresException.Position"/> field, but it is used when the cursor position refers to an internally generated command rather than the one submitted by the client.
- The <see cref="P:Npgsql.PostgresException.InternalQuery" /> field will always appear when this field appears.
- 0 means not provided.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresException.InternalQuery">
- <summary>
- The text of a failed internally-generated command.
- This could be, for example, a SQL query issued by a PL/pgSQL function.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresException.Where">
- <summary>
- An indication of the context in which the error occurred.
- Presently this includes a call stack traceback of active PL functions.
- The trace is one entry per line, most recent first.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresException.SchemaName">
- <summary>
- If the error was associated with a specific database object, the name of the schema containing that object, if any.
- </summary>
- <remarks>PostgreSQL 9.3 and up.</remarks>
- </member>
- <member name="P:Npgsql.PostgresException.TableName">
- <summary>
- Table name: if the error was associated with a specific table, the name of the table.
- (Refer to the schema name field for the name of the table's schema.)
- </summary>
- <remarks>PostgreSQL 9.3 and up.</remarks>
- </member>
- <member name="P:Npgsql.PostgresException.ColumnName">
- <summary>
- If the error was associated with a specific table column, the name of the column.
- (Refer to the schema and table name fields to identify the table.)
- </summary>
- <remarks>PostgreSQL 9.3 and up.</remarks>
- </member>
- <member name="P:Npgsql.PostgresException.DataTypeName">
- <summary>
- If the error was associated with a specific data type, the name of the data type.
- (Refer to the schema name field for the name of the data type's schema.)
- </summary>
- <remarks>PostgreSQL 9.3 and up.</remarks>
- </member>
- <member name="P:Npgsql.PostgresException.ConstraintName">
- <summary>
- If the error was associated with a specific constraint, the name of the constraint.
- Refer to fields listed above for the associated table or domain.
- (For this purpose, indexes are treated as constraints, even if they weren't created with constraint syntax.)
- </summary>
- <remarks>PostgreSQL 9.3 and up.</remarks>
- </member>
- <member name="P:Npgsql.PostgresException.File">
- <summary>
- The file name of the source-code location where the error was reported.
- </summary>
- <remarks>PostgreSQL 9.3 and up.</remarks>
- </member>
- <member name="P:Npgsql.PostgresException.Line">
- <summary>
- The line number of the source-code location where the error was reported.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresException.Routine">
- <summary>
- The name of the source-code routine reporting the error.
- </summary>
- </member>
- <member name="T:Npgsql.PostgresNotice">
- <summary>
- PostgreSQL notices are non-critical messages generated by PostgreSQL, either as a result of a user query
- (e.g. as a warning or informational notice), or due to outside activity (e.g. if the database administrator
- initiates a "fast" database shutdown).
- </summary>
- <remarks>
- https://www.postgresql.org/docs/current/static/protocol-flow.html#PROTOCOL-ASYNC
- </remarks>
- </member>
- <member name="P:Npgsql.PostgresNotice.Severity">
- <summary>
- Severity of the error or notice.
- Always present.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresNotice.InvariantSeverity">
- <summary>
- Severity of the error or notice, not localized.
- Always present since PostgreSQL 9.6.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresNotice.SqlState">
- <summary>
- The SQLSTATE code for the error.
- </summary>
- <remarks>
- Always present.
- See https://www.postgresql.org/docs/current/static/errcodes-appendix.html
- </remarks>
- </member>
- <member name="P:Npgsql.PostgresNotice.Code">
- <summary>
- The SQLSTATE code for the error.
- </summary>
- <remarks>
- Always present.
- See https://www.postgresql.org/docs/current/static/errcodes-appendix.html
- </remarks>
- </member>
- <member name="P:Npgsql.PostgresNotice.MessageText">
- <summary>
- The primary human-readable error message. This should be accurate but terse.
- </summary>
- <remarks>
- Always present.
- </remarks>
- </member>
- <member name="P:Npgsql.PostgresNotice.Detail">
- <summary>
- An optional secondary error message carrying more detail about the problem.
- May run to multiple lines.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresNotice.Hint">
- <summary>
- An optional suggestion what to do about the problem.
- This is intended to differ from Detail in that it offers advice (potentially inappropriate) rather than hard facts.
- May run to multiple lines.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresNotice.Position">
- <summary>
- The field value is a decimal ASCII integer, indicating an error cursor position as an index into the original query string.
- The first character has index 1, and positions are measured in characters not bytes.
- 0 means not provided.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresNotice.InternalPosition">
- <summary>
- This is defined the same as the <see cref="P:Npgsql.PostgresNotice.Position"/> field, but it is used when the cursor position refers to an internally generated command rather than the one submitted by the client.
- The <see cref="P:Npgsql.PostgresNotice.InternalQuery" /> field will always appear when this field appears.
- 0 means not provided.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresNotice.InternalQuery">
- <summary>
- The text of a failed internally-generated command.
- This could be, for example, a SQL query issued by a PL/pgSQL function.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresNotice.Where">
- <summary>
- An indication of the context in which the error occurred.
- Presently this includes a call stack traceback of active PL functions.
- The trace is one entry per line, most recent first.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresNotice.SchemaName">
- <summary>
- If the error was associated with a specific database object, the name of the schema containing that object, if any.
- </summary>
- <remarks>PostgreSQL 9.3 and up.</remarks>
- </member>
- <member name="P:Npgsql.PostgresNotice.TableName">
- <summary>
- Table name: if the error was associated with a specific table, the name of the table.
- (Refer to the schema name field for the name of the table's schema.)
- </summary>
- <remarks>PostgreSQL 9.3 and up.</remarks>
- </member>
- <member name="P:Npgsql.PostgresNotice.ColumnName">
- <summary>
- If the error was associated with a specific table column, the name of the column.
- (Refer to the schema and table name fields to identify the table.)
- </summary>
- <remarks>PostgreSQL 9.3 and up.</remarks>
- </member>
- <member name="P:Npgsql.PostgresNotice.DataTypeName">
- <summary>
- If the error was associated with a specific data type, the name of the data type.
- (Refer to the schema name field for the name of the data type's schema.)
- </summary>
- <remarks>PostgreSQL 9.3 and up.</remarks>
- </member>
- <member name="P:Npgsql.PostgresNotice.ConstraintName">
- <summary>
- If the error was associated with a specific constraint, the name of the constraint.
- Refer to fields listed above for the associated table or domain.
- (For this purpose, indexes are treated as constraints, even if they weren't created with constraint syntax.)
- </summary>
- <remarks>PostgreSQL 9.3 and up.</remarks>
- </member>
- <member name="P:Npgsql.PostgresNotice.File">
- <summary>
- The file name of the source-code location where the error was reported.
- </summary>
- <remarks>PostgreSQL 9.3 and up.</remarks>
- </member>
- <member name="P:Npgsql.PostgresNotice.Line">
- <summary>
- The line number of the source-code location where the error was reported.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresNotice.Routine">
- <summary>
- The name of the source-code routine reporting the error.
- </summary>
- </member>
- <member name="M:Npgsql.PostgresNotice.#ctor(System.String,System.String,System.String,System.String)">
- <summary>
- Creates a new instance.
- </summary>
- </member>
- <member name="M:Npgsql.PostgresNotice.#ctor(System.String,System.String,System.String,System.String,System.String,System.String,System.Int32,System.Int32,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String)">
- <summary>
- Creates a new instance.
- </summary>
- </member>
- <member name="T:Npgsql.NpgsqlNoticeEventArgs">
- <summary>
- Provides data for a PostgreSQL notice event.
- </summary>
- </member>
- <member name="P:Npgsql.NpgsqlNoticeEventArgs.Notice">
- <summary>
- The Notice that was sent from the database.
- </summary>
- </member>
- <member name="T:Npgsql.PostgresTypes.PostgresArrayType">
- <summary>
- Represents a PostgreSQL array data type, which can hold several multiple values in a single column.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/arrays.html.
- </remarks>
- </member>
- <member name="P:Npgsql.PostgresTypes.PostgresArrayType.Element">
- <summary>
- The PostgreSQL data type of the element contained within this array.
- </summary>
- </member>
- <member name="M:Npgsql.PostgresTypes.PostgresArrayType.#ctor(System.String,System.String,System.UInt32,Npgsql.PostgresTypes.PostgresType)">
- <summary>
- Constructs a representation of a PostgreSQL array data type.
- </summary>
- </member>
- <member name="M:Npgsql.PostgresTypes.PostgresArrayType.GetPartialNameWithFacets(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="T:Npgsql.PostgresTypes.PostgresBaseType">
- <summary>
- Represents a PostgreSQL base data type, which is a simple scalar value.
- </summary>
- </member>
- <member name="M:Npgsql.PostgresTypes.PostgresBaseType.#ctor(System.String,System.String,System.UInt32)">
- <inheritdoc/>
- </member>
- <member name="M:Npgsql.PostgresTypes.PostgresBaseType.GetPartialNameWithFacets(System.Int32)">
- <inheritdoc/>
- </member>
- <member name="T:Npgsql.PostgresTypes.PostgresCompositeType">
- <summary>
- Represents a PostgreSQL composite data type, which can hold multiple fields of varying types in a single column.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/rowtypes.html.
- </remarks>
- </member>
- <member name="P:Npgsql.PostgresTypes.PostgresCompositeType.Fields">
- <summary>
- Holds the name and types for all fields.
- </summary>
- </member>
- <member name="M:Npgsql.PostgresTypes.PostgresCompositeType.#ctor(System.String,System.String,System.UInt32)">
- <summary>
- Constructs a representation of a PostgreSQL array data type.
- </summary>
- </member>
- <member name="T:Npgsql.PostgresTypes.PostgresCompositeType.Field">
- <summary>
- Represents a field in a PostgreSQL composite data type.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresTypes.PostgresCompositeType.Field.Name">
- <summary>
- The name of the composite field.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresTypes.PostgresCompositeType.Field.Type">
- <summary>
- The type of the composite field.
- </summary>
- </member>
- <member name="M:Npgsql.PostgresTypes.PostgresCompositeType.Field.ToString">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.PostgresTypes.PostgresDomainType">
- <summary>
- Represents a PostgreSQL domain type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/sql-createdomain.html.
-
- When PostgreSQL returns a RowDescription for a domain type, the type OID is the base type's
- (so fetching a domain type over text returns a RowDescription for text).
- However, when a composite type is returned, the type OID there is that of the domain,
- so we provide "clean" support for domain types.
- </remarks>
- </member>
- <member name="P:Npgsql.PostgresTypes.PostgresDomainType.BaseType">
- <summary>
- The PostgreSQL data type of the base type, i.e. the type this domain is based on.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresTypes.PostgresDomainType.NotNull">
- <summary>
- <b>True</b> if the domain has a NOT NULL constraint, otherwise <b>false</b>.
- </summary>
- </member>
- <member name="M:Npgsql.PostgresTypes.PostgresDomainType.#ctor(System.String,System.String,System.UInt32,Npgsql.PostgresTypes.PostgresType,System.Boolean)">
- <summary>
- Constructs a representation of a PostgreSQL domain data type.
- </summary>
- </member>
- <member name="T:Npgsql.PostgresTypes.PostgresEnumType">
- <summary>
- Represents a PostgreSQL enum data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-enum.html.
- </remarks>
- </member>
- <member name="P:Npgsql.PostgresTypes.PostgresEnumType.Labels">
- <summary>
- The enum's fields.
- </summary>
- </member>
- <member name="M:Npgsql.PostgresTypes.PostgresEnumType.#ctor(System.String,System.String,System.UInt32)">
- <summary>
- Constructs a representation of a PostgreSQL enum data type.
- </summary>
- </member>
- <member name="T:Npgsql.PostgresTypes.PostgresMultirangeType">
- <summary>
- Represents a PostgreSQL multirange data type.
- </summary>
- <remarks>
- <p>See https://www.postgresql.org/docs/current/static/rangetypes.html.</p>
- <p>Multirange types were introduced in PostgreSQL 14.</p>
- </remarks>
- </member>
- <member name="P:Npgsql.PostgresTypes.PostgresMultirangeType.Subrange">
- <summary>
- The PostgreSQL data type of the range of this multirange.
- </summary>
- </member>
- <member name="M:Npgsql.PostgresTypes.PostgresMultirangeType.#ctor(System.String,System.String,System.UInt32,Npgsql.PostgresTypes.PostgresRangeType)">
- <summary>
- Constructs a representation of a PostgreSQL range data type.
- </summary>
- </member>
- <member name="T:Npgsql.PostgresTypes.PostgresRangeType">
- <summary>
- Represents a PostgreSQL range data type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/rangetypes.html.
- </remarks>
- </member>
- <member name="P:Npgsql.PostgresTypes.PostgresRangeType.Subtype">
- <summary>
- The PostgreSQL data type of the subtype of this range.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresTypes.PostgresRangeType.Multirange">
- <summary>
- The PostgreSQL data type of the multirange of this range.
- </summary>
- </member>
- <member name="M:Npgsql.PostgresTypes.PostgresRangeType.#ctor(System.String,System.String,System.UInt32,Npgsql.PostgresTypes.PostgresType)">
- <summary>
- Constructs a representation of a PostgreSQL range data type.
- </summary>
- </member>
- <member name="T:Npgsql.PostgresTypes.PostgresType">
- <summary>
- Represents a PostgreSQL data type, such as int4 or text, as discovered from pg_type.
- This class is abstract, see derived classes for concrete types of PostgreSQL types.
- </summary>
- <remarks>
- Instances of this class are shared between connections to the same databases.
- For more info about what this class and its subclasses represent, see
- https://www.postgresql.org/docs/current/static/catalog-pg-type.html.
- </remarks>
- </member>
- <member name="M:Npgsql.PostgresTypes.PostgresType.#ctor(System.String,System.String,System.UInt32)">
- <summary>
- Constructs a representation of a PostgreSQL data type.
- </summary>
- <param name="ns">The data type's namespace (or schema).</param>
- <param name="name">The data type's name.</param>
- <param name="oid">The data type's OID.</param>
- </member>
- <member name="M:Npgsql.PostgresTypes.PostgresType.#ctor(System.String,System.String,System.String,System.UInt32)">
- <summary>
- Constructs a representation of a PostgreSQL data type.
- </summary>
- <param name="ns">The data type's namespace (or schema).</param>
- <param name="name">The data type's name.</param>
- <param name="internalName">The data type's internal name (e.g. _int4 for integer[]).</param>
- <param name="oid">The data type's OID.</param>
- </member>
- <member name="P:Npgsql.PostgresTypes.PostgresType.OID">
- <summary>
- The data type's OID - a unique id identifying the data type in a given database (in pg_type).
- </summary>
- </member>
- <member name="P:Npgsql.PostgresTypes.PostgresType.Namespace">
- <summary>
- The data type's namespace (or schema).
- </summary>
- </member>
- <member name="P:Npgsql.PostgresTypes.PostgresType.Name">
- <summary>
- The data type's name.
- </summary>
- <remarks>
- Note that this is the standard, user-displayable type name (e.g. integer[]) rather than the internal
- PostgreSQL name as it is in pg_type (_int4). See <see cref="P:Npgsql.PostgresTypes.PostgresType.InternalName"/> for the latter.
- </remarks>
- </member>
- <member name="P:Npgsql.PostgresTypes.PostgresType.FullName">
- <summary>
- The full name of the backend type, including its namespace.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresTypes.PostgresType.DisplayName">
- <summary>
- A display name for this backend type, including the namespace unless it is pg_catalog (the namespace
- for all built-in types).
- </summary>
- </member>
- <member name="P:Npgsql.PostgresTypes.PostgresType.InternalName">
- <summary>
- The data type's internal PostgreSQL name (e.g. integer[] not _int4).
- See <see cref="P:Npgsql.PostgresTypes.PostgresType.Name"/> for a more user-friendly name.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresTypes.PostgresType.Array">
- <summary>
- If a PostgreSQL array type exists for this type, it will be referenced here.
- Otherwise null.
- </summary>
- </member>
- <member name="P:Npgsql.PostgresTypes.PostgresType.Range">
- <summary>
- If a PostgreSQL range type exists for this type, it will be referenced here.
- Otherwise null.
- </summary>
- </member>
- <member name="M:Npgsql.PostgresTypes.PostgresType.GetDisplayNameWithFacets(System.Int32)">
- <summary>
- Generates the type name including any facts (size, precision, scale), given the PostgreSQL type modifier.
- </summary>
- </member>
- <member name="M:Npgsql.PostgresTypes.PostgresType.ToString">
- <summary>
- Returns a string that represents the current object.
- </summary>
- </member>
- <member name="T:Npgsql.PostgresTypes.UnknownBackendType">
- <summary>
- Represents a PostgreSQL data type that isn't known to Npgsql and cannot be handled.
- </summary>
- </member>
- <member name="M:Npgsql.PostgresTypes.UnknownBackendType.#ctor">
- <summary>
- Constructs a the unknown backend type.
- </summary>
- </member>
- <member name="T:Npgsql.PreparedStatement">
- <summary>
- Internally represents a statement has been prepared, is in the process of being prepared, or is a
- candidate for preparation (i.e. awaiting further usages).
- </summary>
- </member>
- <member name="P:Npgsql.PreparedStatement.IsExplicit">
- <summary>
- If true, the user explicitly requested this statement be prepared. It does not get closed as part of
- the automatic preparation LRU mechanism.
- </summary>
- </member>
- <member name="F:Npgsql.PreparedStatement.StatementBeingReplaced">
- <summary>
- If this statement is about to be prepared, but replaces a previous statement which needs to be closed,
- this holds the name of the previous statement. Otherwise null.
- </summary>
- </member>
- <member name="P:Npgsql.PreparedStatement.HandlerParamTypes">
- <summary>
- Contains the handler types for a prepared statement's parameters, for overloaded cases (same SQL, different param types)
- Only populated after the statement has been prepared (i.e. null for candidates).
- </summary>
- </member>
- <member name="T:Npgsql.PreparedState">
- <summary>
- The state of a <see cref="T:Npgsql.PreparedStatement"/>.
- </summary>
- </member>
- <member name="F:Npgsql.PreparedState.NotPrepared">
- <summary>
- The statement hasn't been prepared yet, nor is it in the process of being prepared.
- This is the value for autoprepare candidates which haven't been prepared yet, and is also
- a temporary state during preparation.
- </summary>
- </member>
- <member name="F:Npgsql.PreparedState.BeingPrepared">
- <summary>
- The statement is in the process of being prepared.
- </summary>
- </member>
- <member name="F:Npgsql.PreparedState.Prepared">
- <summary>
- The statement has been fully prepared and can be executed.
- </summary>
- </member>
- <member name="F:Npgsql.PreparedState.BeingUnprepared">
- <summary>
- The statement is in the process of being unprepared. This is a temporary state that only occurs during
- unprepare. Specifically, it means that a Close message for the statement has already been written
- to the write buffer.
- </summary>
- </member>
- <member name="F:Npgsql.PreparedState.Unprepared">
- <summary>
- The statement has been unprepared and is no longer usable.
- </summary>
- </member>
- <member name="F:Npgsql.PreparedStatementManager.NumPrepared">
- <summary>
- Total number of current prepared statements (whether explicit or automatic).
- </summary>
- </member>
- <member name="T:Npgsql.Replication.Internal.LogicalReplicationConnectionExtensions">
- <summary>
- This API is for internal use and for implementing logical replication plugins.
- It is not meant to be consumed in common Npgsql usage scenarios.
- </summary>
- </member>
- <member name="M:Npgsql.Replication.Internal.LogicalReplicationConnectionExtensions.CreateLogicalReplicationSlot(Npgsql.Replication.LogicalReplicationConnection,System.String,System.String,System.Boolean,System.Nullable{Npgsql.Replication.LogicalSlotSnapshotInitMode},System.Threading.CancellationToken)">
- <summary>
- This API is for internal use and for implementing logical replication plugins.
- It is not meant to be consumed in common Npgsql usage scenarios.
- </summary>
- <remarks>
- Creates a new replication slot and returns information about the newly-created slot.
- </remarks>
- <param name="connection">The <see cref="T:Npgsql.Replication.LogicalReplicationConnection"/> to use for creating the
- replication slot</param>
- <param name="slotName">The name of the slot to create. Must be a valid replication slot name (see
- <a href="https://www.postgresql.org/docs/current/warm-standby.html#STREAMING-REPLICATION-SLOTS-MANIPULATION">
- https://www.postgresql.org/docs/current/warm-standby.html#STREAMING-REPLICATION-SLOTS-MANIPULATION</a>).
- </param>
- <param name="outputPlugin">The name of the output plugin used for logical decoding (see
- <a href="https://www.postgresql.org/docs/current/logicaldecoding-output-plugin.html">
- https://www.postgresql.org/docs/current/logicaldecoding-output-plugin.html</a>).
- </param>
- <param name="isTemporary"><see langword="true"/> if this replication slot shall be temporary one; otherwise
- <see langword="false"/>. Temporary slots are not saved to disk and are automatically dropped on error or
- when the session has finished.</param>
- <param name="slotSnapshotInitMode">A <see cref="T:Npgsql.Replication.LogicalSlotSnapshotInitMode"/> to specify what to do with the
- snapshot created during logical slot initialization. <see cref="F:Npgsql.Replication.LogicalSlotSnapshotInitMode.Export"/>, which is
- also the default, will export the snapshot for use in other sessions. This option can't be used inside a
- transaction. <see cref="F:Npgsql.Replication.LogicalSlotSnapshotInitMode.Use"/> will use the snapshot for the current transaction
- executing the command. This option must be used in a transaction, and <see cref="F:Npgsql.Replication.LogicalSlotSnapshotInitMode.Use"/>
- must be the first command run in that transaction. Finally, <see cref="F:Npgsql.Replication.LogicalSlotSnapshotInitMode.NoExport"/> will
- just use the snapshot for logical decoding as normal but won't do anything else with it.</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing a <see cref="T:Npgsql.Replication.ReplicationSlotOptions"/> class that
- can be used to initialize instances of <see cref="T:Npgsql.Replication.ReplicationSlot"/> subclasses.</returns>
- </member>
- <member name="M:Npgsql.Replication.Internal.LogicalReplicationConnectionExtensions.StartLogicalReplication(Npgsql.Replication.LogicalReplicationConnection,Npgsql.Replication.Internal.LogicalReplicationSlot,System.Threading.CancellationToken,System.Nullable{NpgsqlTypes.NpgsqlLogSequenceNumber},System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}},System.Boolean)">
- <summary>
- Instructs the server to start streaming the WAL for logical replication, starting at WAL location
- <paramref name="walLocation"/> or at the slot's consistent point if <paramref name="walLocation"/> isn't specified.
- The server can reply with an error, for example if the requested section of the WAL has already been recycled.
- </summary>
- <param name="connection">The <see cref="T:Npgsql.Replication.LogicalReplicationConnection"/> to use for starting replication</param>
- <param name="slot">The replication slot that will be updated as replication progresses so that the server
- knows which WAL segments are still needed by the standby.
- </param>
- <param name="cancellationToken">The token to monitor for stopping the replication.</param>
- <param name="walLocation">The WAL location to begin streaming at.</param>
- <param name="options">The collection of options passed to the slot's logical decoding plugin.</param>
- <param name="bypassingStream">
- Whether the plugin will be bypassing <see cref="P:Npgsql.Replication.XLogDataMessage.Data" /> and reading directly from the buffer.
- </param>
- <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing an <see cref="T:System.Collections.Generic.IAsyncEnumerable`1"/> that
- can be used to stream WAL entries in form of <see cref="T:Npgsql.Replication.XLogDataMessage"/> instances.</returns>
- </member>
- <member name="T:Npgsql.Replication.Internal.LogicalReplicationSlot">
- <summary>
- Contains information about a newly-created logical replication slot.
- </summary>
- </member>
- <member name="M:Npgsql.Replication.Internal.LogicalReplicationSlot.#ctor(System.String,Npgsql.Replication.ReplicationSlotOptions)">
- <summary>
- Creates a new logical replication slot
- </summary>
- <param name="outputPlugin">The logical decoding output plugin to the corresponding replication slot was created for.</param>
- <param name="replicationSlotOptions">A <see cref="T:Npgsql.Replication.ReplicationSlotOptions"/> struct with information to create the replication slot.</param>
- </member>
- <member name="P:Npgsql.Replication.Internal.LogicalReplicationSlot.SnapshotName">
- <summary>
- The identifier of the snapshot exported by the command.
- The snapshot is valid until a new command is executed on this connection or the replication connection is closed.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.Internal.LogicalReplicationSlot.OutputPlugin">
- <summary>
- The name of the output plugin used by the newly-created logical replication slot.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.Internal.LogicalReplicationSlot.ConsistentPoint">
- <summary>
- The WAL location at which the slot became consistent.
- This is the earliest location from which streaming can start on this replication slot.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.LogicalReplicationConnection">
- <summary>
- Represents a logical replication connection to a PostgreSQL server.
- </summary>
- </member>
- <member name="M:Npgsql.Replication.LogicalReplicationConnection.#ctor">
- <summary>
- Initializes a new instance of <see cref="T:Npgsql.Replication.LogicalReplicationConnection"/>.
- </summary>
- </member>
- <member name="M:Npgsql.Replication.LogicalReplicationConnection.#ctor(System.String)">
- <summary>
- Initializes a new instance of <see cref="T:Npgsql.Replication.LogicalReplicationConnection"/> with the given connection string.
- </summary>
- <param name="connectionString">The connection used to open the PostgreSQL database.</param>
- </member>
- <member name="T:Npgsql.Replication.LogicalSlotSnapshotInitMode">
- <summary>
- Decides what to do with the snapshot created during logical slot initialization.
- </summary>
- </member>
- <member name="F:Npgsql.Replication.LogicalSlotSnapshotInitMode.Export">
- <summary>
- Export the snapshot for use in other sessions. This is the default.
- This option can't be used inside a transaction.
- </summary>
- </member>
- <member name="F:Npgsql.Replication.LogicalSlotSnapshotInitMode.Use">
- <summary>
- Use the snapshot for the current transaction executing the command.
- This option must be used in a transaction, and CREATE_REPLICATION_SLOT must be the first command run
- in that transaction.
- </summary>
- </member>
- <member name="F:Npgsql.Replication.LogicalSlotSnapshotInitMode.NoExport">
- <summary>
- Just use the snapshot for logical decoding as normal but don't do anything else with it.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.BeginMessage">
- <summary>
- Logical Replication Protocol begin message
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.BeginMessage.TransactionFinalLsn">
- <summary>
- The final LSN of the transaction.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.BeginMessage.TransactionCommitTimestamp">
- <summary>
- Commit timestamp of the transaction.
- The value is in number of microseconds since PostgreSQL epoch (2000-01-01).
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.CommitMessage">
- <summary>
- Logical Replication Protocol commit message
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.CommitMessage.Flags">
- <summary>
- Flags; currently unused.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.CommitMessage.CommitLsn">
- <summary>
- The LSN of the commit.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.CommitMessage.TransactionEndLsn">
- <summary>
- The end LSN of the transaction.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.CommitMessage.TransactionCommitTimestamp">
- <summary>
- Commit timestamp of the transaction.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.CommitMessage.CommitFlags">
- <summary>
- Flags for the commit.
- </summary>
- </member>
- <member name="F:Npgsql.Replication.PgOutput.Messages.CommitMessage.CommitFlags.None">
- <summary>
- No flags.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.DefaultUpdateMessage">
- <summary>
- Logical Replication Protocol update message for tables with REPLICA IDENTITY set to DEFAULT.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.DefaultUpdateMessage.NewRow">
- <summary>
- Columns representing the new row.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.DeleteMessage">
- <summary>
- Abstract base class for Logical Replication Protocol delete message types.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.DeleteMessage.Relation">
- <summary>
- The relation for this <see cref="T:Npgsql.Replication.PgOutput.Messages.InsertMessage" />.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.DeleteMessage.RelationId">
- <summary>
- ID of the relation corresponding to the ID in the relation message.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.FullDeleteMessage">
- <summary>
- Logical Replication Protocol delete message for tables with REPLICA IDENTITY REPLICA IDENTITY set to FULL.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.FullDeleteMessage.OldRow">
- <summary>
- Columns representing the deleted row.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.FullUpdateMessage">
- <summary>
- Logical Replication Protocol update message for tables with REPLICA IDENTITY set to FULL.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.FullUpdateMessage.OldRow">
- <summary>
- Columns representing the old row.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.FullUpdateMessage.NewRow">
- <summary>
- Columns representing the new row.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.IndexUpdateMessage">
- <summary>
- Logical Replication Protocol update message for tables with REPLICA IDENTITY set to USING INDEX.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.IndexUpdateMessage.Key">
- <summary>
- Columns representing the key.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.IndexUpdateMessage.NewRow">
- <summary>
- Columns representing the new row.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.InsertMessage">
- <summary>
- Logical Replication Protocol insert message
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.InsertMessage.Relation">
- <summary>
- The relation for this <see cref="T:Npgsql.Replication.PgOutput.Messages.InsertMessage" />.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.InsertMessage.RelationId">
- <summary>
- ID of the relation corresponding to the ID in the relation message.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.InsertMessage.NewRow">
- <summary>
- Columns representing the new row.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.KeyDeleteMessage">
- <summary>
- Logical Replication Protocol delete message for tables with REPLICA IDENTITY set to DEFAULT or USING INDEX.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.KeyDeleteMessage.Key">
- <summary>
- Columns representing the key.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.LogicalDecodingMessage">
- <summary>
- Logical Replication Protocol logical decoding message
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.LogicalDecodingMessage.Flags">
- <summary>
- Flags; Either 0 for no flags or 1 if the logical decoding message is transactional.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.LogicalDecodingMessage.MessageLsn">
- <summary>
- The LSN of the logical decoding message.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.LogicalDecodingMessage.Prefix">
- <summary>
- The prefix of the logical decoding message.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.LogicalDecodingMessage.Data">
- <summary>
- The content of the logical decoding message.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.OriginMessage">
- <summary>
- Logical Replication Protocol origin message
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.OriginMessage.OriginCommitLsn">
- <summary>
- The LSN of the commit on the origin server.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.OriginMessage.OriginName">
- <summary>
- Name of the origin.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.PgOutputReplicationMessage">
- <summary>
- The base class of all Logical Replication Protocol Messages
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/protocol-logicalrep-message-formats.html for details about the
- protocol.
- </remarks>
- </member>
- <member name="M:Npgsql.Replication.PgOutput.Messages.PgOutputReplicationMessage.ToString">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.RelationMessage">
- <summary>
- Logical Replication Protocol relation message
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.RelationMessage.RelationId">
- <summary>
- ID of the relation.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.RelationMessage.Namespace">
- <summary>
- Namespace (empty string for pg_catalog).
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.RelationMessage.RelationName">
- <summary>
- Relation name.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.RelationMessage.ReplicaIdentity">
- <summary>
- Replica identity setting for the relation (same as <c>relreplident</c> in <c>pg_class</c>):
- columns used to form “replica identity” for rows.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.RelationMessage.Columns">
- <summary>
- Relation columns
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.RelationMessage.Column">
- <summary>
- Represents a column in a Logical Replication Protocol relation message
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.RelationMessage.Column.Flags">
- <summary>
- Flags for the column.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.RelationMessage.Column.ColumnName">
- <summary>
- Name of the column.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.RelationMessage.Column.DataTypeId">
- <summary>
- ID of the column's data type.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.RelationMessage.Column.TypeModifier">
- <summary>
- Type modifier of the column (atttypmod).
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.RelationMessage.Column.ColumnFlags">
- <summary>
- Flags for the column.
- </summary>
- </member>
- <member name="F:Npgsql.Replication.PgOutput.Messages.RelationMessage.Column.ColumnFlags.None">
- <summary>
- No flags.
- </summary>
- </member>
- <member name="F:Npgsql.Replication.PgOutput.Messages.RelationMessage.Column.ColumnFlags.PartOfKey">
- <summary>
- Marks the column as part of the key.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.RelationMessage.ReplicaIdentitySetting">
- <summary>
- Replica identity setting for the relation (same as <c>relreplident</c> in <c>pg_class</c>).
- </summary>
- <remarks>
- See <see href="https://www.postgresql.org/docs/current/catalog-pg-class.html" />
- </remarks>
- </member>
- <member name="F:Npgsql.Replication.PgOutput.Messages.RelationMessage.ReplicaIdentitySetting.Default">
- <summary>
- Default (primary key, if any).
- </summary>
- </member>
- <member name="F:Npgsql.Replication.PgOutput.Messages.RelationMessage.ReplicaIdentitySetting.Nothing">
- <summary>
- Nothing.
- </summary>
- </member>
- <member name="F:Npgsql.Replication.PgOutput.Messages.RelationMessage.ReplicaIdentitySetting.AllColumns">
- <summary>
- All columns.
- </summary>
- </member>
- <member name="F:Npgsql.Replication.PgOutput.Messages.RelationMessage.ReplicaIdentitySetting.IndexWithIndIsReplIdent">
- <summary>
- Index with <c>indisreplident</c> set (same as nothing if the index used has been dropped)
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.RelationMessageColumn">
- <summary>
- Represents a column in a Logical Replication Protocol relation message
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.RelationMessageColumn.Flags">
- <summary>
- Flags for the column. Currently can be either 0 for no flags or 1 which marks the column as part of the key.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.RelationMessageColumn.ColumnName">
- <summary>
- Name of the column.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.RelationMessageColumn.DataTypeId">
- <summary>
- ID of the column's data type.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.RelationMessageColumn.TypeModifier">
- <summary>
- Type modifier of the column (atttypmod).
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.StreamAbortMessage">
- <summary>
- Logical Replication Protocol stream abort message
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.StreamAbortMessage.SubtransactionXid">
- <summary>
- Xid of the subtransaction (will be same as xid of the transaction for top-level transactions).
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.StreamCommitMessage">
- <summary>
- Logical Replication Protocol stream commit message
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.StreamCommitMessage.Flags">
- <summary>
- Flags; currently unused (must be 0).
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.StreamCommitMessage.CommitLsn">
- <summary>
- The LSN of the commit.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.StreamCommitMessage.TransactionEndLsn">
- <summary>
- The end LSN of the transaction.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.StreamCommitMessage.TransactionCommitTimestamp">
- <summary>
- Commit timestamp of the transaction.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.StreamStartMessage">
- <summary>
- Logical Replication Protocol stream start message
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.StreamStartMessage.StreamSegmentIndicator">
- <summary>
- A value of 1 indicates this is the first stream segment for this XID, 0 for any other stream segment.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.StreamStopMessage">
- <summary>
- Logical Replication Protocol stream stop message
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.TransactionalMessage">
- <summary>
- The common base class for all streaming replication messages that can be part of a streaming transaction (protocol V2)
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.TransactionalMessage.TransactionXid">
- <summary>
- Xid of the transaction (only present for streamed transactions).
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.TransactionControlMessage">
- <summary>
- The common base class for all replication messages that set the transaction xid of a transaction
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.TransactionControlMessage.TransactionXid">
- <summary>
- Xid of the transaction.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.TruncateMessage">
- <summary>
- Logical Replication Protocol truncate message
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.TruncateMessage.Options">
- <summary>
- Option flags for TRUNCATE
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.TruncateMessage.Relations">
- <summary>
- The relations being truncated.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.TruncateMessage.TruncateOptions">
- <summary>
- Enum representing the additional options for the TRUNCATE command as flags
- </summary>
- </member>
- <member name="F:Npgsql.Replication.PgOutput.Messages.TruncateMessage.TruncateOptions.None">
- <summary>
- No additional option was specified
- </summary>
- </member>
- <member name="F:Npgsql.Replication.PgOutput.Messages.TruncateMessage.TruncateOptions.Cascade">
- <summary>
- CASCADE was specified
- </summary>
- </member>
- <member name="F:Npgsql.Replication.PgOutput.Messages.TruncateMessage.TruncateOptions.RestartIdentity">
- <summary>
- RESTART IDENTITY was specified
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.TypeMessage">
- <summary>
- Logical Replication Protocol type message
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.TypeMessage.TypeId">
- <summary>
- ID of the data type.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.TypeMessage.Namespace">
- <summary>
- Namespace (empty string for pg_catalog).
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.TypeMessage.Name">
- <summary>
- Name of the data type.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.Messages.UpdateMessage">
- <summary>
- Abstract base class for Logical Replication Protocol delete message types.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.UpdateMessage.Relation">
- <summary>
- The relation for this <see cref="T:Npgsql.Replication.PgOutput.Messages.InsertMessage" />.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.UpdateMessage.RelationId">
- <summary>
- ID of the relation corresponding to the ID in the relation message.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.Messages.UpdateMessage.NewRow">
- <summary>
- Columns representing the new row.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.PgOutputReplicationOptions">
- <summary>
- Options to be passed to the pgoutput plugin
- </summary>
- </member>
- <member name="M:Npgsql.Replication.PgOutput.PgOutputReplicationOptions.#ctor(System.String,System.UInt64,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean})">
- <summary>
- Creates a new instance of <see cref="T:Npgsql.Replication.PgOutput.PgOutputReplicationOptions"/>.
- </summary>
- <param name="publicationName">The publication names to include into the stream</param>
- <param name="protocolVersion">The version of the logical streaming replication protocol</param>
- <param name="binary">Send values in binary representation</param>
- <param name="streaming">Enable streaming of in-progress transactions</param>
- <param name="messages">Write logical decoding messages into the replication stream</param>
- </member>
- <member name="M:Npgsql.Replication.PgOutput.PgOutputReplicationOptions.#ctor(System.Collections.Generic.IEnumerable{System.String},System.UInt64,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean})">
- <summary>
- Creates a new instance of <see cref="T:Npgsql.Replication.PgOutput.PgOutputReplicationOptions"/>.
- </summary>
- <param name="publicationNames">The publication names to include into the stream</param>
- <param name="protocolVersion">The version of the logical streaming replication protocol</param>
- <param name="binary">Send values in binary representation</param>
- <param name="streaming">Enable streaming of in-progress transactions</param>
- <param name="messages">Write logical decoding messages into the replication stream</param>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.PgOutputReplicationOptions.ProtocolVersion">
- <summary>
- The version of the Logical Streaming Replication Protocol
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.PgOutputReplicationOptions.PublicationNames">
- <summary>
- The publication names to stream
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.PgOutputReplicationOptions.Binary">
- <summary>
- Send values in binary representation
- </summary>
- <remarks>
- This works in PostgreSQL versions 14+
- </remarks>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.PgOutputReplicationOptions.Streaming">
- <summary>
- Enable streaming of in-progress transactions
- </summary>
- <remarks>
- This works as of logical streaming replication protocol version 2 (PostgreSQL 14+)
- </remarks>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.PgOutputReplicationOptions.Messages">
- <summary>
- Write logical decoding messages into the replication stream
- </summary>
- <remarks>
- This works in PostgreSQL versions 14+
- </remarks>
- </member>
- <member name="M:Npgsql.Replication.PgOutput.PgOutputReplicationOptions.Equals(Npgsql.Replication.PgOutput.PgOutputReplicationOptions)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Replication.PgOutput.PgOutputReplicationOptions.Equals(System.Object)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Replication.PgOutput.PgOutputReplicationOptions.GetHashCode">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Replication.PgOutput.PgOutputReplicationSlot">
- <summary>
- Acts as a proxy for a logical replication slot initialized for for the logical streaming replication protocol
- (pgoutput logical decoding plugin).
- </summary>
- </member>
- <member name="M:Npgsql.Replication.PgOutput.PgOutputReplicationSlot.#ctor(System.String)">
- <summary>
- Creates a new <see cref="T:Npgsql.Replication.PgOutput.PgOutputReplicationSlot"/> instance.
- </summary>
- <remarks>
- Create a <see cref="T:Npgsql.Replication.PgOutput.PgOutputReplicationSlot"/> instance with this
- constructor to wrap an existing PostgreSQL replication slot that has
- been initialized for the pgoutput logical decoding plugin.
- </remarks>
- <param name="slotName">The name of the existing replication slot</param>
- </member>
- <member name="M:Npgsql.Replication.PgOutput.PgOutputReplicationSlot.#ctor(Npgsql.Replication.ReplicationSlotOptions)">
- <summary>
- Creates a new <see cref="T:Npgsql.Replication.PgOutput.PgOutputReplicationSlot"/> instance.
- </summary>
- <remarks>
- Create a <see cref="T:Npgsql.Replication.PgOutput.PgOutputReplicationSlot"/> instance with this
- constructor to wrap an existing PostgreSQL replication slot that has
- been initialized for the pgoutput logical decoding plugin.
- </remarks>
- <param name="options">The <see cref="T:Npgsql.Replication.ReplicationSlotOptions"/> representing the existing replication slot</param>
- </member>
- <member name="M:Npgsql.Replication.PgOutput.PgOutputReplicationSlot.#ctor(Npgsql.Replication.PgOutput.PgOutputReplicationSlot)">
- <summary>
- Creates a new <see cref="T:Npgsql.Replication.PgOutput.PgOutputReplicationSlot"/> instance.
- </summary>
- <remarks>
- This constructor is intended to be consumed by plugins sitting on top of
- <see cref="T:Npgsql.Replication.PgOutput.PgOutputReplicationSlot"/>
- </remarks>
- <param name="slot">The <see cref="T:Npgsql.Replication.PgOutput.PgOutputReplicationSlot"/> from which the new instance should be initialized</param>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.ReplicationTuple">
- <summary>
- Represents a streaming tuple containing <see cref="T:Npgsql.Replication.PgOutput.ReplicationValue"/>.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.ReplicationTuple.NumColumns">
- <summary>
- The number of columns in the tuple.
- </summary>
- </member>
- <member name="M:Npgsql.Replication.PgOutput.ReplicationTuple.GetAsyncEnumerator(System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Replication.PgOutput.ReplicationValue">
- <summary>
- Represents a column value in a logical replication session.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.ReplicationValue.Length">
- <summary>
- The length of the value in bytes.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.ReplicationValue.Kind">
- <summary>
- The kind of data transmitted for a tuple in a Logical Replication Protocol message.
- </summary>
- </member>
- <member name="F:Npgsql.Replication.PgOutput.ReplicationValue._columnStream">
- <summary>
- A stream that has been opened on a column.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.ReplicationValue.IsDBNull">
- <summary>
- Gets a value that indicates whether the column contains nonexistent or missing values.
- </summary>
- <returns><b>true</b> if the specified column is equivalent to <see cref="T:System.DBNull"/>; otherwise <b>false</b>.</returns>
- </member>
- <member name="P:Npgsql.Replication.PgOutput.ReplicationValue.IsUnchangedToastedValue">
- <summary>
- Gets a value that indicates whether the column contains an unchanged TOASTed value (the actual value is not sent).
- </summary>
- <returns>Whether the specified column is an unchanged TOASTed value.</returns>
- </member>
- <member name="M:Npgsql.Replication.PgOutput.ReplicationValue.GetPostgresType">
- <summary>
- Gets a representation of the PostgreSQL data type for the specified field.
- The returned representation can be used to access various information about the field.
- </summary>
- </member>
- <member name="M:Npgsql.Replication.PgOutput.ReplicationValue.GetDataTypeName">
- <summary>
- Gets the data type information for the specified field.
- This is be the PostgreSQL type name (e.g. double precision), not the .NET type
- (see <see cref="M:Npgsql.Replication.PgOutput.ReplicationValue.GetFieldType"/> for that).
- </summary>
- </member>
- <member name="M:Npgsql.Replication.PgOutput.ReplicationValue.GetFieldType">
- <summary>
- Gets the data type of the specified column.
- </summary>
- <returns>The data type of the specified column.</returns>
- </member>
- <member name="M:Npgsql.Replication.PgOutput.ReplicationValue.Get``1(System.Threading.CancellationToken)">
- <summary>
- Gets the value of the specified column as a type.
- </summary>
- <typeparam name="T">The type of the value to be returned.</typeparam>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns></returns>
- </member>
- <member name="M:Npgsql.Replication.PgOutput.ReplicationValue.Get(System.Threading.CancellationToken)">
- <summary>
- Gets the value of the specified column as an instance of <see cref="T:System.Object"/>.
- </summary>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns></returns>
- </member>
- <member name="M:Npgsql.Replication.PgOutput.ReplicationValue.GetStream">
- <summary>
- Retrieves data as a <see cref="T:System.IO.Stream"/>.
- </summary>
- </member>
- <member name="M:Npgsql.Replication.PgOutput.ReplicationValue.GetTextReader">
- <summary>
- Retrieves data as a <see cref="T:System.IO.TextReader"/>.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.PgOutput.TupleDataKind">
- <summary>
- The kind of data transmitted for a tuple in a Logical Replication Protocol message.
- </summary>
- </member>
- <member name="F:Npgsql.Replication.PgOutput.TupleDataKind.Null">
- <summary>
- Identifies the data as NULL value.
- </summary>
- </member>
- <member name="F:Npgsql.Replication.PgOutput.TupleDataKind.UnchangedToastedValue">
- <summary>
- Identifies unchanged TOASTed value (the actual value is not sent).
- </summary>
- </member>
- <member name="F:Npgsql.Replication.PgOutput.TupleDataKind.TextValue">
- <summary>
- Identifies the data as text formatted value.
- </summary>
- </member>
- <member name="F:Npgsql.Replication.PgOutput.TupleDataKind.BinaryValue">
- <summary>
- Identifies the data as binary value.
- </summary>
- <remarks>Added in PG14</remarks>
- </member>
- <member name="T:Npgsql.Replication.PgOutputConnectionExtensions">
- <summary>
- Extension methods to use <see cref="T:Npgsql.Replication.LogicalReplicationConnection"/> with the pg_output logical decoding plugin.
- </summary>
- </member>
- <member name="M:Npgsql.Replication.PgOutputConnectionExtensions.CreatePgOutputReplicationSlot(Npgsql.Replication.LogicalReplicationConnection,System.String,System.Boolean,System.Nullable{Npgsql.Replication.LogicalSlotSnapshotInitMode},System.Threading.CancellationToken)">
- <summary>
- Creates a <see cref="T:Npgsql.Replication.Internal.LogicalReplicationSlot"/> class that wraps a replication slot using the
- "pgoutput" logical decoding plugin and can be used to start streaming replication via the logical
- streaming replication protocol.
- </summary>
- <remarks>
- See <a href="https://www.postgresql.org/docs/current/protocol-logical-replication.html">https://www.postgresql.org/docs/current/protocol-logical-replication.html</a>
- and <a href="https://www.postgresql.org/docs/current/protocol-logicalrep-message-formats.html">https://www.postgresql.org/docs/current/protocol-logicalrep-message-formats.html</a>
- for more information.
- </remarks>
- <param name="connection">The <see cref="T:Npgsql.Replication.LogicalReplicationConnection"/> to use for creating the replication slot</param>
- <param name="slotName">The name of the slot to create. Must be a valid replication slot name (see
- <a href="https://www.postgresql.org/docs/current/warm-standby.html#STREAMING-REPLICATION-SLOTS-MANIPULATION">https://www.postgresql.org/docs/current/warm-standby.html#STREAMING-REPLICATION-SLOTS-MANIPULATION</a>).
- </param>
- <param name="temporarySlot">
- <see langword="true"/> if this replication slot shall be temporary one; otherwise <see langword="false"/>.
- Temporary slots are not saved to disk and are automatically dropped on error or when the session has finished.
- </param>
- <param name="slotSnapshotInitMode">
- A <see cref="T:Npgsql.Replication.LogicalSlotSnapshotInitMode"/> to specify what to do with the snapshot created during logical slot
- initialization. <see cref="F:Npgsql.Replication.LogicalSlotSnapshotInitMode.Export"/>, which is also the default, will export the
- snapshot for use in other sessions. This option can't be used inside a transaction.
- <see cref="F:Npgsql.Replication.LogicalSlotSnapshotInitMode.Use"/> will use the snapshot for the current transaction executing the
- command. This option must be used in a transaction, and <see cref="F:Npgsql.Replication.LogicalSlotSnapshotInitMode.Use"/> must be the
- first command run in that transaction. Finally, <see cref="F:Npgsql.Replication.LogicalSlotSnapshotInitMode.NoExport"/> will just use
- the snapshot for logical decoding as normal but won't do anything else with it.
- </param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>
- A <see cref="T:Npgsql.Replication.Internal.LogicalReplicationSlot"/> that wraps the newly-created replication slot.
- </returns>
- </member>
- <member name="M:Npgsql.Replication.PgOutputConnectionExtensions.StartReplication(Npgsql.Replication.LogicalReplicationConnection,Npgsql.Replication.PgOutput.PgOutputReplicationSlot,Npgsql.Replication.PgOutput.PgOutputReplicationOptions,System.Threading.CancellationToken,System.Nullable{NpgsqlTypes.NpgsqlLogSequenceNumber})">
- <summary>
- Instructs the server to start the Logical Streaming Replication Protocol (pgoutput logical decoding plugin),
- starting at WAL location <paramref name="walLocation"/> or at the slot's consistent point if <paramref name="walLocation"/>
- isn't specified.
- The server can reply with an error, for example if the requested section of the WAL has already been recycled.
- </summary>
- <param name="connection">The <see cref="T:Npgsql.Replication.LogicalReplicationConnection"/> to use for starting replication</param>
- <param name="slot">The replication slot that will be updated as replication progresses so that the server
- knows which WAL segments are still needed by the standby.
- </param>
- <param name="options">The collection of options passed to the slot's logical decoding plugin.</param>
- <param name="cancellationToken">The token to monitor for stopping the replication.</param>
- <param name="walLocation">The WAL location to begin streaming at.</param>
- <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing an <see cref="T:System.Collections.Generic.IAsyncEnumerable`1"/> that
- can be used to stream WAL entries in form of <see cref="T:Npgsql.Replication.PgOutput.Messages.PgOutputReplicationMessage"/> instances.</returns>
- </member>
- <member name="T:Npgsql.Replication.PhysicalReplicationConnection">
- <summary>
- Represents a physical replication connection to a PostgreSQL server.
- </summary>
- </member>
- <member name="M:Npgsql.Replication.PhysicalReplicationConnection.#ctor">
- <summary>
- Initializes a new instance of <see cref="T:Npgsql.Replication.PhysicalReplicationConnection"/>.
- </summary>
- </member>
- <member name="M:Npgsql.Replication.PhysicalReplicationConnection.#ctor(System.String)">
- <summary>
- Initializes a new instance of <see cref="T:Npgsql.Replication.PhysicalReplicationConnection"/> with the given connection string.
- </summary>
- <param name="connectionString">The connection used to open the PostgreSQL database.</param>
- </member>
- <member name="M:Npgsql.Replication.PhysicalReplicationConnection.CreateReplicationSlot(System.String,System.Boolean,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Creates a <see cref="T:Npgsql.Replication.PhysicalReplicationSlot"/> that wraps a PostgreSQL physical replication slot and
- can be used to start physical streaming replication
- </summary>
- <param name="slotName">
- The name of the slot to create. Must be a valid replication slot name
- (see <a href="https://www.postgresql.org/docs/current/warm-standby.html#STREAMING-REPLICATION-SLOTS-MANIPULATION">Section 26.2.6.1</a>).
- </param>
- <param name="isTemporary">
- <see langword="true"/> if this replication slot shall be a temporary one; otherwise
- <see langword="false"/>. Temporary slots are not saved to disk and are automatically dropped on error or
- when the session has finished.
- </param>
- <param name="reserveWal">
- If this is set to <see langword="true"/> this physical replication slot reserves WAL immediately. Otherwise,
- WAL is only reserved upon connection from a streaming replication client.
- </param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>A <see cref="T:Npgsql.Replication.PhysicalReplicationSlot"/> that wraps the newly-created replication slot.
- </returns>
- </member>
- <member name="M:Npgsql.Replication.PhysicalReplicationConnection.StartReplication(Npgsql.Replication.PhysicalReplicationSlot,NpgsqlTypes.NpgsqlLogSequenceNumber,System.Threading.CancellationToken,System.UInt32)">
- <summary>
- Instructs the server to start streaming the WAL for physical replication, starting at WAL location
- <paramref name="walLocation"/>. The server can reply with an error, for example if the requested
- section of the WAL has already been recycled.
- </summary>
- <remarks>
- If the client requests a timeline that's not the latest but is part of the history of the server, the server
- will stream all the WAL on that timeline starting from the requested start point up to the point where the
- server switched to another timeline.
- </remarks>
- <param name="slot">
- The replication slot that will be updated as replication progresses so that the server
- knows which WAL segments are still needed by the standby.
- </param>
- <param name="walLocation">The WAL location to begin streaming at.</param>
- <param name="cancellationToken">The token to be used for stopping the replication.</param>
- <param name="timeline">Streaming starts on timeline tli.</param>
- <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing an <see cref="T:System.Collections.Generic.IAsyncEnumerable`1"/> that
- can be used to stream WAL entries in form of <see cref="T:Npgsql.Replication.XLogDataMessage"/> instances.</returns>
- </member>
- <member name="M:Npgsql.Replication.PhysicalReplicationConnection.StartReplication(NpgsqlTypes.NpgsqlLogSequenceNumber,System.Threading.CancellationToken,System.UInt32)">
- <summary>
- Instructs the server to start streaming the WAL for logical replication, starting at WAL location
- <paramref name="walLocation"/>. The server can reply with an error, for example if the requested
- section of WAL has already been recycled.
- </summary>
- <remarks>
- If the client requests a timeline that's not the latest but is part of the history of the server, the server
- will stream all the WAL on that timeline starting from the requested start point up to the point where the
- server switched to another timeline.
- </remarks>
- <param name="walLocation">The WAL location to begin streaming at.</param>
- <param name="cancellationToken">The token to be used for stopping the replication.</param>
- <param name="timeline">Streaming starts on timeline tli.</param>
- <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing an <see cref="T:System.Collections.Generic.IAsyncEnumerable`1"/> that
- can be used to stream WAL entries in form of <see cref="T:Npgsql.Replication.XLogDataMessage"/> instances.</returns>
- </member>
- <member name="T:Npgsql.Replication.PhysicalReplicationSlot">
- <summary>
- Wraps a replication slot that uses physical replication.
- </summary>
- </member>
- <member name="M:Npgsql.Replication.PhysicalReplicationSlot.#ctor(System.String)">
- <summary>
- Creates a new <see cref="T:Npgsql.Replication.PhysicalReplicationSlot"/> instance.
- </summary>
- <remarks>
- Create a <see cref="T:Npgsql.Replication.PhysicalReplicationSlot"/> instance with this constructor to wrap an existing PostgreSQL replication slot
- that has been initialized for physical replication.
- </remarks>
- <param name="slotName">The name of the existing replication slot</param>
- </member>
- <member name="T:Npgsql.Replication.ReplicationConnection">
- <summary>
- Defines the core behavior of replication connections and provides the base class for
- <see cref="T:Npgsql.Replication.LogicalReplicationConnection"/> and
- <see cref="T:Npgsql.Replication.PhysicalReplicationConnection"/>.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.ReplicationConnection.ConnectionString">
- <summary>
- Gets or sets the string used to connect to a PostgreSQL database. See the manual for details.
- </summary>
- <value>
- The connection string that includes the server name, the database name, and other parameters needed to establish the initial
- connection. The default value is an empty string.
- </value>
- <remarks>
- Since replication connections are a special kind of connection,
- <see cref="P:Npgsql.NpgsqlConnectionStringBuilder.Pooling"/>, <see cref="P:Npgsql.NpgsqlConnectionStringBuilder.Enlist"/>,
- <see cref="P:Npgsql.NpgsqlConnectionStringBuilder.Multiplexing" /> and <see cref="P:Npgsql.NpgsqlConnectionStringBuilder.KeepAlive"/>
- are always disabled no matter what you set them to in your connection string.
- </remarks>
- </member>
- <member name="P:Npgsql.Replication.ReplicationConnection.LastReceivedLsn">
- <summary>
- The location of the last WAL byte + 1 received in the standby.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.ReplicationConnection.LastFlushedLsn">
- <summary>
- The location of the last WAL byte + 1 flushed to disk in the standby.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.ReplicationConnection.LastAppliedLsn">
- <summary>
- The location of the last WAL byte + 1 applied (e. g. written to disk) in the standby.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.ReplicationConnection.WalReceiverStatusInterval">
- <summary>
- Send replies at least this often.
- Timeout.<see cref="F:System.Threading.Timeout.InfiniteTimeSpan"/> disables automated replies.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.ReplicationConnection.WalReceiverTimeout">
- <summary>
- Time that receiver waits for communication from master.
- Timeout.<see cref="F:System.Threading.Timeout.InfiniteTimeSpan"/> disables the timeout.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.ReplicationConnection.PostgreSqlVersion">
- <summary>
- The version of the PostgreSQL server we're connected to.
- <remarks>
- <p>
- This can only be called when the connection is open.
- </p>
- <p>
- In case of a development or pre-release version this field will contain
- the version of the next version to be released from this branch.
- </p>
- </remarks>
- </summary>
- </member>
- <member name="P:Npgsql.Replication.ReplicationConnection.ServerVersion">
- <summary>
- The PostgreSQL server version as returned by the server_version option.
- <remarks>
- This can only be called when the connection is open.
- </remarks>
- </summary>
- </member>
- <member name="P:Npgsql.Replication.ReplicationConnection.CommandTimeout">
- <summary>
- Gets or sets the wait time before terminating the attempt to execute a command and generating an error.
- </summary>
- <value>The time to wait for the command to execute. The default value is 30 seconds.</value>
- </member>
- <member name="P:Npgsql.Replication.ReplicationConnection.Encoding">
- <summary>
- The client encoding for the connection
- This can only be called when there is an active connection.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.ReplicationConnection.ProcessID">
- <summary>
- Process id of backend server.
- This can only be called when there is an active connection.
- </summary>
- </member>
- <member name="M:Npgsql.Replication.ReplicationConnection.Open(System.Threading.CancellationToken)">
- <summary>
- Opens a database replication connection with the property settings specified by the
- <see cref="P:Npgsql.Replication.ReplicationConnection.ConnectionString"/>.
- </summary>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>A task representing the asynchronous open operation.</returns>
- </member>
- <member name="M:Npgsql.Replication.ReplicationConnection.DisposeAsync">
- <summary>
- Closes the replication connection and performs tasks associated
- with freeing, releasing, or resetting its unmanaged resources asynchronously.
- </summary>
- <returns>A task that represents the asynchronous dispose operation.</returns>
- </member>
- <member name="M:Npgsql.Replication.ReplicationConnection.IdentifySystem(System.Threading.CancellationToken)">
- <summary>
- Requests the server to identify itself.
- </summary>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>
- A <see cref="T:Npgsql.Replication.ReplicationSystemIdentification"/> containing information about the system we are connected to.
- </returns>
- </member>
- <member name="M:Npgsql.Replication.ReplicationConnection.Show(System.String,System.Threading.CancellationToken)">
- <summary>
- Requests the server to send the current setting of a run-time parameter.
- This is similar to the SQL command SHOW.
- </summary>
- <param name="parameterName">The name of a run-time parameter.
- Available parameters are documented in https://www.postgresql.org/docs/current/runtime-config.html.
- </param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>The current setting of the run-time parameter specified in <paramref name="parameterName"/> as <see cref="T:System.String"/>.</returns>
- </member>
- <member name="M:Npgsql.Replication.ReplicationConnection.TimelineHistory(System.UInt32,System.Threading.CancellationToken)">
- <summary>
- Requests the server to send over the timeline history file for timeline tli.
- </summary>
- <param name="tli">The timeline for which the history file should be sent.</param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>The timeline history file for timeline tli</returns>
- </member>
- <member name="M:Npgsql.Replication.ReplicationConnection.SetReplicationStatus(NpgsqlTypes.NpgsqlLogSequenceNumber)">
- <summary>
- Sets the current status of the replication as it is interpreted by the consuming client. The value supplied
- in <see paramref="lastAppliedAndFlushedLsn" /> will be sent to the server via <see cref="P:Npgsql.Replication.ReplicationConnection.LastAppliedLsn"/> and
- <see cref="P:Npgsql.Replication.ReplicationConnection.LastFlushedLsn"/> with the next status update.
- <para>
- A status update which will happen upon server request, upon expiration of <see cref="P:Npgsql.Replication.ReplicationConnection.WalReceiverStatusInterval"/>
- our upon an enforced status update via <see cref="M:Npgsql.Replication.ReplicationConnection.SendStatusUpdate(System.Threading.CancellationToken)"/>, whichever happens first.
- If you want the value you set here to be pushed to the server immediately (e. g. in synchronous replication scenarios),
- call <see cref="M:Npgsql.Replication.ReplicationConnection.SendStatusUpdate(System.Threading.CancellationToken)"/> after calling this method.
- </para>
- </summary>
- <remarks>
- This is a convenience method setting both <see cref="P:Npgsql.Replication.ReplicationConnection.LastAppliedLsn"/> and <see cref="P:Npgsql.Replication.ReplicationConnection.LastFlushedLsn"/> in one operation.
- You can use it if your application processes replication messages in a way that doesn't care about the difference between
- writing a message and flushing it to a permanent storage medium.
- </remarks>
- <param name="lastAppliedAndFlushedLsn">The location of the last WAL byte + 1 applied (e. g. processed or written to disk) and flushed to disk in the standby.</param>
- </member>
- <member name="M:Npgsql.Replication.ReplicationConnection.SendStatusUpdate(System.Threading.CancellationToken)">
- <summary>
- Sends a forced status update to PostgreSQL with the current WAL tracking information.
- </summary>
- <exception cref="T:System.InvalidOperationException">The connection currently isn't streaming</exception>
- <returns>A Task representing the sending of the status update (and not any PostgreSQL response).</returns>
- </member>
- <member name="M:Npgsql.Replication.ReplicationConnection.DropReplicationSlot(System.String,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Drops a replication slot, freeing any reserved server-side resources.
- If the slot is a logical slot that was created in a database other than
- the database the walsender is connected to, this command fails.
- </summary>
- <param name="slotName">The name of the slot to drop.</param>
- <param name="wait">
- <see langword="true"/> causes the command to wait until the slot becomes
- inactive if it currently is active instead of the default behavior of raising an error.
- </param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>A task representing the asynchronous drop operation.</returns>
- </member>
- <member name="T:Npgsql.Replication.ReplicationMessage">
- <summary>
- The common base class for all streaming replication messages
- </summary>
- </member>
- <member name="P:Npgsql.Replication.ReplicationMessage.WalStart">
- <summary>
- The starting point of the WAL data in this message.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.ReplicationMessage.WalEnd">
- <summary>
- The current end of WAL on the server.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.ReplicationMessage.ServerClock">
- <summary>
- The server's system clock at the time this message was transmitted, as microseconds since midnight on 2000-01-01.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.ReplicationSlot">
- <summary>
- Contains information about a newly-created replication slot.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.ReplicationSlot.Name">
- <summary>
- The name of the newly-created replication slot.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.ReplicationSlotOptions">
- <summary>
- Contains information about a replication slot.
- </summary>
- </member>
- <member name="M:Npgsql.Replication.ReplicationSlotOptions.#ctor(System.String,System.String)">
- <summary>
- Creates a new <see cref="T:Npgsql.Replication.ReplicationSlotOptions"/> instance.
- </summary>
- <param name="slotName">
- The name of the replication slot.
- </param>
- <param name="consistentPoint">
- The WAL location at which the slot became consistent.
- </param>
- </member>
- <member name="M:Npgsql.Replication.ReplicationSlotOptions.#ctor(System.String,NpgsqlTypes.NpgsqlLogSequenceNumber)">
- <summary>
- Creates a new <see cref="T:Npgsql.Replication.ReplicationSlotOptions"/> instance.
- </summary>
- <param name="slotName">
- The name of the replication slot.
- </param>
- <param name="consistentPoint">
- The WAL location at which the slot became consistent.
- </param>
- </member>
- <member name="P:Npgsql.Replication.ReplicationSlotOptions.SlotName">
- <summary>
- The name of the replication slot.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.ReplicationSlotOptions.ConsistentPoint">
- <summary>
- The WAL location at which the slot became consistent.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.ReplicationSlotOptions.SnapshotName">
- <summary>
- The identifier of the snapshot exported by the CREATE_REPLICATION_SLOT command.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.ReplicationSystemIdentification">
- <summary>
- Contains server identification information returned from <see cref="M:Npgsql.Replication.ReplicationConnection.IdentifySystem(System.Threading.CancellationToken)"/>.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.ReplicationSystemIdentification.SystemId">
- <summary>
- The unique system identifier identifying the cluster.
- This can be used to check that the base backup used to initialize the standby came from the same cluster.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.ReplicationSystemIdentification.Timeline">
- <summary>
- Current timeline ID. Also useful to check that the standby is consistent with the master.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.ReplicationSystemIdentification.XLogPos">
- <summary>
- Current WAL flush location. Useful to get a known location in the write-ahead log where streaming can start.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.ReplicationSystemIdentification.DbName">
- <summary>
- Database connected to.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.TestDecoding.TestDecodingData">
- <summary>
- Text representations of PostgreSQL WAL operations decoded by the "test_decoding" plugin. See
- https://www.postgresql.org/docs/current/test-decoding.html.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.TestDecoding.TestDecodingData.Data">
- <summary>
- Decoded text representation of the operation performed in this WAL entry
- </summary>
- </member>
- <member name="M:Npgsql.Replication.TestDecoding.TestDecodingData.ToString">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Replication.TestDecoding.TestDecodingData.Clone">
- <summary>
- Returns a clone of this message, which can be accessed after other replication messages have been retrieved.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.TestDecoding.TestDecodingOptions">
- <summary>
- Options to be passed to the test_decoding plugin
- </summary>
- </member>
- <member name="M:Npgsql.Replication.TestDecoding.TestDecodingOptions.#ctor(System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean})">
- <summary>
- Creates a new instance of <see cref="T:Npgsql.Replication.TestDecoding.TestDecodingOptions"/>.
- </summary>
- <param name="includeXids">Include the transaction number for BEGIN and COMMIT command output</param>
- <param name="includeTimestamp">Include the timestamp for COMMIT command output</param>
- <param name="forceBinary">Set the <a href="https://www.postgresql.org/docs/current/logicaldecoding-output-plugin.html#LOGICALDECODING-OUTPUT-MODE">output mode</a> to binary</param>
- <param name="skipEmptyXacts">Skip output for transactions that didn't change the database</param>
- <param name="onlyLocal">Only output data that don't have the <a href="https://www.postgresql.org/docs/11/replication-origins.html">replication origin</a> set</param>
- <param name="includeRewrites">Include output from table rewrites that were caused by DDL statements</param>
- <param name="streamChanges">Enable streaming output</param>
- </member>
- <member name="P:Npgsql.Replication.TestDecoding.TestDecodingOptions.IncludeXids">
- <summary>
- Include the transaction number for BEGIN and COMMIT command output
- </summary>
- </member>
- <member name="P:Npgsql.Replication.TestDecoding.TestDecodingOptions.IncludeTimestamp">
- <summary>
- Include the timestamp for COMMIT command output
- </summary>
- </member>
- <member name="P:Npgsql.Replication.TestDecoding.TestDecodingOptions.ForceBinary">
- <summary>
- Set the <a href="https://www.postgresql.org/docs/current/logicaldecoding-output-plugin.html#LOGICALDECODING-OUTPUT-MODE">output mode</a> to binary
- </summary>
- </member>
- <member name="P:Npgsql.Replication.TestDecoding.TestDecodingOptions.SkipEmptyXacts">
- <summary>
- Skip output for transactions that didn't change the database
- </summary>
- </member>
- <member name="P:Npgsql.Replication.TestDecoding.TestDecodingOptions.OnlyLocal">
- <summary>
- Only output data that don't have the <a href="https://www.postgresql.org/docs/11/replication-origins.html">replication origin</a> set
- </summary>
- </member>
- <member name="P:Npgsql.Replication.TestDecoding.TestDecodingOptions.IncludeRewrites">
- <summary>
- Include output from table rewrites that were caused by DDL statements
- </summary>
- </member>
- <member name="P:Npgsql.Replication.TestDecoding.TestDecodingOptions.StreamChanges">
- <summary>
- Enable streaming output
- </summary>
- </member>
- <member name="M:Npgsql.Replication.TestDecoding.TestDecodingOptions.Equals(Npgsql.Replication.TestDecoding.TestDecodingOptions)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Replication.TestDecoding.TestDecodingOptions.Equals(System.Object)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.Replication.TestDecoding.TestDecodingOptions.GetHashCode">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Replication.TestDecoding.TestDecodingReplicationSlot">
- <summary>
- Acts as a proxy for a logical replication slot
- initialized for for the test_decoding logical decoding plugin.
- </summary>
- </member>
- <member name="M:Npgsql.Replication.TestDecoding.TestDecodingReplicationSlot.#ctor(System.String)">
- <summary>
- Creates a new <see cref="T:Npgsql.Replication.TestDecoding.TestDecodingReplicationSlot"/> instance.
- </summary>
- <remarks>
- Create a <see cref="T:Npgsql.Replication.TestDecoding.TestDecodingReplicationSlot"/> instance with this
- constructor to wrap an existing PostgreSQL replication slot that has
- been initialized for the test_decoding logical decoding plugin.
- </remarks>
- <param name="slotName">The name of the existing replication slot</param>
- </member>
- <member name="M:Npgsql.Replication.TestDecoding.TestDecodingReplicationSlot.#ctor(Npgsql.Replication.ReplicationSlotOptions)">
- <summary>
- Creates a new <see cref="T:Npgsql.Replication.TestDecoding.TestDecodingReplicationSlot"/> instance.
- </summary>
- <remarks>
- Create a <see cref="T:Npgsql.Replication.TestDecoding.TestDecodingReplicationSlot"/> instance with this
- constructor to wrap an existing PostgreSQL replication slot that has
- been initialized for the test_decoding logical decoding plugin.
- </remarks>
- <param name="options">The <see cref="T:Npgsql.Replication.ReplicationSlotOptions"/> representing the existing replication slot</param>
- </member>
- <member name="T:Npgsql.Replication.TestDecodingConnectionExtensions">
- <summary>
- Extension methods to use <see cref="T:Npgsql.Replication.LogicalReplicationConnection"/> with the
- test_decoding logical decoding plugin.
- See <a href="https://www.postgresql.org/docs/current/test-decoding.html">https://www.postgresql.org/docs/current/test-decoding.html</a>.
- </summary>
- </member>
- <member name="M:Npgsql.Replication.TestDecodingConnectionExtensions.CreateTestDecodingReplicationSlot(Npgsql.Replication.LogicalReplicationConnection,System.String,System.Boolean,System.Nullable{Npgsql.Replication.LogicalSlotSnapshotInitMode},System.Threading.CancellationToken)">
- <summary>
- Creates a <see cref="T:Npgsql.Replication.TestDecoding.TestDecodingReplicationSlot"/> class that wraps a replication slot using the
- test_decoding logical decoding plugin.
- </summary>
- <remarks>
- See <a href="https://www.postgresql.org/docs/current/test-decoding.html">https://www.postgresql.org/docs/current/test-decoding.html</a>
- for more information.
- </remarks>
- <param name="connection">The <see cref="T:Npgsql.Replication.LogicalReplicationConnection"/> to use for creating the
- replication slot</param>
- <param name="slotName">The name of the slot to create. Must be a valid replication slot name (see
- <a href="https://www.postgresql.org/docs/current/warm-standby.html#STREAMING-REPLICATION-SLOTS-MANIPULATION">https://www.postgresql.org/docs/current/warm-standby.html#STREAMING-REPLICATION-SLOTS-MANIPULATION</a>).
- </param>
- <param name="temporarySlot">
- <see langword="true"/> if this replication slot shall be temporary one; otherwise <see langword="false"/>.
- Temporary slots are not saved to disk and are automatically dropped on error or when the session has finished.
- </param>
- <param name="slotSnapshotInitMode">
- A <see cref="T:Npgsql.Replication.LogicalSlotSnapshotInitMode"/> to specify what to do with the snapshot created during logical slot
- initialization. <see cref="F:Npgsql.Replication.LogicalSlotSnapshotInitMode.Export"/>, which is also the default, will export the
- snapshot for use in other sessions. This option can't be used inside a transaction.
- <see cref="F:Npgsql.Replication.LogicalSlotSnapshotInitMode.Use"/> will use the snapshot for the current transaction executing the
- command. This option must be used in a transaction, and <see cref="F:Npgsql.Replication.LogicalSlotSnapshotInitMode.Use"/> must be the
- first command run in that transaction. Finally, <see cref="F:Npgsql.Replication.LogicalSlotSnapshotInitMode.NoExport"/> will just use
- the snapshot for logical decoding as normal but won't do anything else with it.
- </param>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>
- A <see cref="T:Npgsql.Replication.TestDecoding.TestDecodingReplicationSlot"/> that wraps the newly-created replication slot.
- </returns>
- </member>
- <member name="M:Npgsql.Replication.TestDecodingConnectionExtensions.StartReplication(Npgsql.Replication.LogicalReplicationConnection,Npgsql.Replication.TestDecoding.TestDecodingReplicationSlot,System.Threading.CancellationToken,Npgsql.Replication.TestDecoding.TestDecodingOptions,System.Nullable{NpgsqlTypes.NpgsqlLogSequenceNumber})">
- <summary>
- Instructs the server to start streaming the WAL for logical replication using the test_decoding logical decoding plugin,
- starting at WAL location <paramref name="walLocation"/> or at the slot's consistent point if <paramref name="walLocation"/>
- isn't specified.
- The server can reply with an error, for example if the requested section of the WAL has already been recycled.
- </summary>
- <param name="connection">The <see cref="T:Npgsql.Replication.LogicalReplicationConnection"/> to use for starting replication</param>
- <param name="slot">The replication slot that will be updated as replication progresses so that the server
- knows which WAL segments are still needed by the standby.
- </param>
- <param name="cancellationToken">The token to monitor for stopping the replication.</param>
- <param name="options">The collection of options passed to the slot's logical decoding plugin.</param>
- <param name="walLocation">The WAL location to begin streaming at.</param>
- <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing an <see cref="T:System.Collections.Generic.IAsyncEnumerable`1"/> that
- can be used to stream WAL entries in form of <see cref="T:Npgsql.Replication.TestDecoding.TestDecodingData"/> instances.</returns>
- </member>
- <member name="T:Npgsql.Replication.TimelineHistoryFile">
- <summary>
- Represents a PostgreSQL timeline history file
- </summary>
- </member>
- <member name="P:Npgsql.Replication.TimelineHistoryFile.FileName">
- <summary>
- File name of the timeline history file, e.g., 00000002.history.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.TimelineHistoryFile.Content">
- <summary>
- Contents of the timeline history file.
- </summary>
- </member>
- <member name="T:Npgsql.Replication.XLogDataMessage">
- <summary>
- A message representing a section of the WAL data stream.
- </summary>
- </member>
- <member name="P:Npgsql.Replication.XLogDataMessage.Data">
- <summary>
- A section of the WAL data stream that is raw WAL data in physical replication or decoded with the selected
- logical decoding plugin in logical replication. It is only valid until the next <see cref="T:Npgsql.Replication.XLogDataMessage"/>
- is requested from the stream.
- </summary>
- <remarks>
- A single WAL record is never split across two XLogData messages.
- When a WAL record crosses a WAL page boundary, and is therefore already split using continuation records,
- it can be split at the page boundary. In other words, the first main WAL record and its continuation
- records can be sent in different XLogData messages.
- </remarks>
- </member>
- <member name="M:Npgsql.Schema.DbColumnSchemaGenerator.GenerateOldColumnsQuery(System.String)">
- <summary>
- Stripped-down version of <see cref="M:Npgsql.Schema.DbColumnSchemaGenerator.GenerateColumnsQuery(System.Version,System.String)"/>, mainly to support Amazon Redshift.
- </summary>
- </member>
- <member name="M:Npgsql.Schema.DbColumnSchemaGenerator.ColumnPostConfig(Npgsql.Schema.NpgsqlDbColumn,System.Int32)">
- <summary>
- Performs some post-setup configuration that's common to both table columns and non-columns.
- </summary>
- </member>
- <member name="T:Npgsql.Schema.NpgsqlDbColumn">
- <summary>
- Provides schema information about a column.
- </summary>
- <remarks>
- Note that this can correspond to a field returned in a query which isn't an actual table column
-
- See https://msdn.microsoft.com/en-us/library/system.data.sqlclient.sqldatareader.getschematable(v=vs.110).aspx
- for information on the meaning of the different fields.
- </remarks>
- </member>
- <member name="M:Npgsql.Schema.NpgsqlDbColumn.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Npgsql.Schema.NpgsqlDbColumn" /> class.
- </summary>
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.AllowDBNull">
- <inheritdoc cref="P:System.Data.Common.DbColumn.AllowDBNull" />
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.BaseCatalogName">
- <inheritdoc cref="P:System.Data.Common.DbColumn.BaseCatalogName" />
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.BaseColumnName">
- <inheritdoc cref="P:System.Data.Common.DbColumn.BaseColumnName" />
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.BaseSchemaName">
- <inheritdoc cref="P:System.Data.Common.DbColumn.BaseSchemaName" />
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.BaseServerName">
- <inheritdoc cref="P:System.Data.Common.DbColumn.BaseServerName" />
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.BaseTableName">
- <inheritdoc cref="P:System.Data.Common.DbColumn.BaseTableName" />
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.ColumnName">
- <inheritdoc cref="P:System.Data.Common.DbColumn.ColumnName" />
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.ColumnOrdinal">
- <inheritdoc cref="P:System.Data.Common.DbColumn.ColumnOrdinal" />
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.ColumnSize">
- <inheritdoc cref="P:System.Data.Common.DbColumn.ColumnSize" />
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.IsAliased">
- <inheritdoc cref="P:System.Data.Common.DbColumn.IsAliased" />
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.IsAutoIncrement">
- <inheritdoc cref="P:System.Data.Common.DbColumn.IsAutoIncrement" />
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.IsKey">
- <inheritdoc cref="P:System.Data.Common.DbColumn.IsKey" />
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.IsLong">
- <inheritdoc cref="P:System.Data.Common.DbColumn.IsLong" />
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.IsReadOnly">
- <inheritdoc cref="P:System.Data.Common.DbColumn.IsReadOnly" />
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.IsUnique">
- <inheritdoc cref="P:System.Data.Common.DbColumn.IsUnique" />
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.NumericPrecision">
- <inheritdoc cref="P:System.Data.Common.DbColumn.NumericPrecision" />
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.NumericScale">
- <inheritdoc cref="P:System.Data.Common.DbColumn.NumericScale" />
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.UdtAssemblyQualifiedName">
- <inheritdoc cref="P:System.Data.Common.DbColumn.UdtAssemblyQualifiedName" />
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.DataType">
- <inheritdoc cref="P:System.Data.Common.DbColumn.DataType" />
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.DataTypeName">
- <inheritdoc cref="P:System.Data.Common.DbColumn.DataTypeName" />
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.PostgresType">
- <summary>
- The <see cref="P:Npgsql.Schema.NpgsqlDbColumn.PostgresType" /> describing the type of this column.
- </summary>
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.TypeOID">
- <summary>
- The OID of the type of this column in the PostgreSQL pg_type catalog table.
- </summary>
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.TableOID">
- <summary>
- The OID of the PostgreSQL table of this column.
- </summary>
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.ColumnAttributeNumber">
- <summary>
- The column's position within its table. Note that this is different from <see cref="P:Npgsql.Schema.NpgsqlDbColumn.ColumnOrdinal" />,
- which is the column's position within the resultset.
- </summary>
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.DefaultValue">
- <summary>
- The default SQL expression for this column.
- </summary>
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.NpgsqlDbType">
- <summary>
- The <see cref="P:Npgsql.Schema.NpgsqlDbColumn.NpgsqlDbType" /> value for this column's type.
- </summary>
- </member>
- <member name="P:Npgsql.Schema.NpgsqlDbColumn.Item(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.SqlQueryParser.ParseRawQuery(Npgsql.NpgsqlCommand,System.Boolean,System.Boolean)">
- <summary>
- <p>
- Receives a user SQL query as passed in by the user in <see cref="P:Npgsql.NpgsqlCommand.CommandText"/> or
- <see cref="P:Npgsql.NpgsqlBatchCommand.CommandText"/>, and rewrites it for PostgreSQL compatibility.
- </p>
- <p>
- This includes doing rewriting named parameter placeholders to positional (@p => $1), and splitting the query
- up by semicolons (legacy batching, SELECT 1; SELECT 2).
- </p>
- </summary>
- <param name="command">The user-facing <see cref="T:Npgsql.NpgsqlCommand"/> being executed.</param>
- <param name="standardConformingStrings">Whether PostgreSQL standards-conforming are used.</param>
- <param name="deriveParameters">
- A bool indicating whether parameters contains a list of preconfigured parameters or an empty list to be filled with derived
- parameters.
- </param>
- </member>
- <member name="M:Npgsql.SqlQueryParser.ParseRawQuery(Npgsql.NpgsqlBatchCommand,System.Boolean,System.Boolean)">
- <summary>
- <p>
- Receives a user SQL query as passed in by the user in <see cref="P:Npgsql.NpgsqlCommand.CommandText"/> or
- <see cref="P:Npgsql.NpgsqlBatchCommand.CommandText"/>, and rewrites it for PostgreSQL compatibility.
- </p>
- <p>
- This includes doing rewriting named parameter placeholders to positional (@p => $1), and splitting the query
- up by semicolons (legacy batching, SELECT 1; SELECT 2).
- </p>
- </summary>
- <param name="batchCommand"> The user-facing <see cref="T:Npgsql.NpgsqlBatchCommand"/> being executed.</param>
- <param name="standardConformingStrings">Whether PostgreSQL standards-conforming are used.</param>
- <param name="deriveParameters">
- A bool indicating whether parameters contains a list of preconfigured parameters or an empty list to be filled with derived
- parameters.
- </param>
- </member>
- <member name="M:Npgsql.TaskExtensions.WithTimeout``1(System.Threading.Tasks.Task{``0},Npgsql.Util.NpgsqlTimeout)">
- <summary>
- Utility that simplifies awaiting a task with a timeout. If the given task does not
- complete within <paramref name="timeout"/>, a <see cref="T:System.TimeoutException"/> is thrown.
- </summary>
- <param name="task">The task to be awaited</param>
- <param name="timeout">How much time to allow <paramref name="task"/> to complete before throwing a <see cref="T:System.TimeoutException"/></param>
- <returns>An awaitable task that represents the original task plus the timeout</returns>
- </member>
- <member name="M:Npgsql.TaskExtensions.WithCancellation``1(System.Threading.Tasks.Task{``0},System.Threading.CancellationToken)">
- <summary>
- Allows you to cancel awaiting for a non-cancellable task.
- </summary>
- <remarks>
- Read https://blogs.msdn.com/b/pfxteam/archive/2012/10/05/how-do-i-cancel-non-cancelable-async-operations.aspx
- and be very careful with this.
- </remarks>
- </member>
- <member name="M:Npgsql.TaskExtensions.WithTimeout(System.Threading.Tasks.Task,Npgsql.Util.NpgsqlTimeout)">
- <summary>
- Utility that simplifies awaiting a task with a timeout. If the given task does not
- complete within <paramref name="timeout"/>, a <see cref="T:System.TimeoutException"/> is thrown.
- </summary>
- <param name="task">The task to be awaited</param>
- <param name="timeout">How much time to allow <paramref name="task"/> to complete before throwing a <see cref="T:System.TimeoutException"/></param>
- <returns>An awaitable task that represents the original task plus the timeout</returns>
- </member>
- <member name="M:Npgsql.TaskExtensions.WithCancellation(System.Threading.Tasks.Task,System.Threading.CancellationToken)">
- <summary>
- Allows you to cancel awaiting for a non-cancellable task.
- </summary>
- <remarks>
- Read https://blogs.msdn.com/b/pfxteam/archive/2012/10/05/how-do-i-cancel-non-cancelable-async-operations.aspx
- and be very careful with this.
- </remarks>
- </member>
- <member name="P:Npgsql.TypeMapping.ConnectorTypeMapper.ChangeCounter">
- <summary>
- Copy of <see cref="P:Npgsql.TypeMapping.GlobalTypeMapper.ChangeCounter"/> at the time when this
- mapper was created, to detect mapping changes. If changes are made to this connection's
- mapper, the change counter is set to -1.
- </summary>
- </member>
- <member name="M:Npgsql.TypeMapping.ConnectorTypeMapper.ResolveByOID(System.UInt32)">
- <summary>
- Looks up a type handler by its PostgreSQL type's OID.
- </summary>
- <param name="oid">A PostgreSQL type OID</param>
- <returns>A type handler that can be used to encode and decode values.</returns>
- </member>
- <member name="P:Npgsql.TypeMapping.GlobalTypeMapper.ChangeCounter">
- <summary>
- A counter that is incremented whenever a global mapping change occurs.
- Used to invalidate bound type mappers.
- </summary>
- </member>
- <member name="T:Npgsql.TypeMapping.INpgsqlTypeMapper">
- <summary>
- A type mapper, managing how to read and write CLR values to PostgreSQL data types.
- A type mapper exists for each connection, as well as a single global type mapper
- (accessible via <see cref="P:NpgsqlConnection.GlobalTypeMapper"/>).
- </summary>
- <remarks>
- </remarks>
- </member>
- <member name="P:Npgsql.TypeMapping.INpgsqlTypeMapper.DefaultNameTranslator">
- <summary>
- The default name translator to convert CLR type names and member names.
- </summary>
- </member>
- <member name="M:Npgsql.TypeMapping.INpgsqlTypeMapper.MapEnum``1(System.String,Npgsql.INpgsqlNameTranslator)">
- <summary>
- Maps a CLR enum to a PostgreSQL enum type.
- </summary>
- <remarks>
- CLR enum labels are mapped by name to PostgreSQL enum labels.
- The translation strategy can be controlled by the <paramref name="nameTranslator"/> parameter,
- which defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>.
- You can also use the <see cref="T:NpgsqlTypes.PgNameAttribute"/> on your enum fields to manually specify a PostgreSQL enum label.
- If there is a discrepancy between the .NET and database labels while an enum is read or written,
- an exception will be raised.
- </remarks>
- <param name="pgName">
- A PostgreSQL type name for the corresponding enum type in the database.
- If null, the name translator given in <paramref name="nameTranslator"/> will be used.
- </param>
- <param name="nameTranslator">
- A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
- Defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>
- </param>
- <typeparam name="TEnum">The .NET enum type to be mapped</typeparam>
- </member>
- <member name="M:Npgsql.TypeMapping.INpgsqlTypeMapper.UnmapEnum``1(System.String,Npgsql.INpgsqlNameTranslator)">
- <summary>
- Removes an existing enum mapping.
- </summary>
- <param name="pgName">
- A PostgreSQL type name for the corresponding enum type in the database.
- If null, the name translator given in <paramref name="nameTranslator"/> will be used.
- </param>
- <param name="nameTranslator">
- A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
- Defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>
- </param>
- </member>
- <member name="M:Npgsql.TypeMapping.INpgsqlTypeMapper.MapComposite``1(System.String,Npgsql.INpgsqlNameTranslator)">
- <summary>
- Maps a CLR type to a PostgreSQL composite type.
- </summary>
- <remarks>
- CLR fields and properties by string to PostgreSQL names.
- The translation strategy can be controlled by the <paramref name="nameTranslator"/> parameter,
- which defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>.
- You can also use the <see cref="T:NpgsqlTypes.PgNameAttribute"/> on your members to manually specify a PostgreSQL name.
- If there is a discrepancy between the .NET type and database type while a composite is read or written,
- an exception will be raised.
- </remarks>
- <param name="pgName">
- A PostgreSQL type name for the corresponding composite type in the database.
- If null, the name translator given in <paramref name="nameTranslator"/> will be used.
- </param>
- <param name="nameTranslator">
- A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
- Defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>
- </param>
- <typeparam name="T">The .NET type to be mapped</typeparam>
- </member>
- <member name="M:Npgsql.TypeMapping.INpgsqlTypeMapper.UnmapComposite``1(System.String,Npgsql.INpgsqlNameTranslator)">
- <summary>
- Removes an existing composite mapping.
- </summary>
- <param name="pgName">
- A PostgreSQL type name for the corresponding composite type in the database.
- If null, the name translator given in <paramref name="nameTranslator"/> will be used.
- </param>
- <param name="nameTranslator">
- A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
- Defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>
- </param>
- </member>
- <member name="M:Npgsql.TypeMapping.INpgsqlTypeMapper.MapComposite(System.Type,System.String,Npgsql.INpgsqlNameTranslator)">
- <summary>
- Maps a CLR type to a composite type.
- </summary>
- <remarks>
- Maps CLR fields and properties by string to PostgreSQL names.
- The translation strategy can be controlled by the <paramref name="nameTranslator"/> parameter,
- which defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>.
- If there is a discrepancy between the .NET type and database type while a composite is read or written,
- an exception will be raised.
- </remarks>
- <param name="clrType">The .NET type to be mapped.</param>
- <param name="pgName">
- A PostgreSQL type name for the corresponding composite type in the database.
- If null, the name translator given in <paramref name="nameTranslator"/> will be used.
- </param>
- <param name="nameTranslator">
- A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
- Defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>
- </param>
- </member>
- <member name="M:Npgsql.TypeMapping.INpgsqlTypeMapper.UnmapComposite(System.Type,System.String,Npgsql.INpgsqlNameTranslator)">
- <summary>
- Removes an existing composite mapping.
- </summary>
- <param name="clrType">The .NET type to be unmapped.</param>
- <param name="pgName">
- A PostgreSQL type name for the corresponding composite type in the database.
- If null, the name translator given in <paramref name="nameTranslator"/> will be used.
- </param>
- <param name="nameTranslator">
- A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
- Defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>
- </param>
- </member>
- <member name="M:Npgsql.TypeMapping.INpgsqlTypeMapper.AddTypeResolverFactory(Npgsql.Internal.TypeHandling.TypeHandlerResolverFactory)">
- <summary>
- Adds a type resolver factory, which produces resolvers that can add or modify support for PostgreSQL types.
- Typically used by plugins.
- </summary>
- <param name="resolverFactory">The type resolver factory to be added.</param>
- </member>
- <member name="M:Npgsql.TypeMapping.INpgsqlTypeMapper.Reset">
- <summary>
- Resets all mapping changes performed on this type mapper and reverts it to its original, starting state.
- </summary>
- </member>
- <member name="T:Npgsql.TypeMapping.PostgresTypeOIDs">
- <summary>
- Holds well-known, built-in PostgreSQL type OIDs.
- </summary>
- <remarks>
- Source: <see href="https://github.com/postgres/postgres/blob/master/src/include/catalog/pg_type.dat" />
- </remarks>
- </member>
- <member name="M:Npgsql.TypeMapping.TypeMapperBase.MapEnum``1(System.String,Npgsql.INpgsqlNameTranslator)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.TypeMapping.TypeMapperBase.UnmapEnum``1(System.String,Npgsql.INpgsqlNameTranslator)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.TypeMapping.TypeMapperBase.MapComposite``1(System.String,Npgsql.INpgsqlNameTranslator)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.TypeMapping.TypeMapperBase.MapComposite(System.Type,System.String,Npgsql.INpgsqlNameTranslator)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.TypeMapping.TypeMapperBase.UnmapComposite``1(System.String,Npgsql.INpgsqlNameTranslator)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.TypeMapping.TypeMapperBase.UnmapComposite(System.Type,System.String,Npgsql.INpgsqlNameTranslator)">
- <inheritdoc />
- </member>
- <member name="M:Npgsql.TypeMapping.TypeMapperBase.AddTypeResolverFactory(Npgsql.Internal.TypeHandling.TypeHandlerResolverFactory)">
- <inheritdoc />
- </member>
- <member name="T:Npgsql.Util.NpgsqlTimeout">
- <summary>
- Represents a timeout that will expire at some point.
- </summary>
- </member>
- <member name="T:Npgsql.Util.ResettableCancellationTokenSource">
- <summary>
- A wrapper around <see cref="T:System.Threading.CancellationTokenSource"/> to simplify reset management.
- </summary>
- <remarks>
- Since there's no way to reset a <see cref="T:System.Threading.CancellationTokenSource"/> once it was cancelled,
- we need to make sure that an existing cancellation token source hasn't been cancelled,
- every time we start it (see https://github.com/dotnet/runtime/issues/4694).
- </remarks>
- </member>
- <member name="F:Npgsql.Util.ResettableCancellationTokenSource.lockObject">
- <summary>
- Used, so we wouldn't concurently use the cts for the cancellation, while it's being disposed
- </summary>
- </member>
- <member name="M:Npgsql.Util.ResettableCancellationTokenSource.Start(System.Threading.CancellationToken)">
- <summary>
- Set the timeout on the wrapped <see cref="T:System.Threading.CancellationTokenSource"/>
- and make sure that it hasn't been cancelled yet
- </summary>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>The <see cref="T:System.Threading.CancellationToken"/> from the wrapped <see cref="T:System.Threading.CancellationTokenSource"/></returns>
- </member>
- <member name="M:Npgsql.Util.ResettableCancellationTokenSource.RestartTimeoutWithoutReset">
- <summary>
- Restart the timeout on the wrapped <see cref="T:System.Threading.CancellationTokenSource"/> without reinitializing it,
- even if <see cref="P:Npgsql.Util.ResettableCancellationTokenSource.IsCancellationRequested"/> is already set to <see langword="true"/>
- </summary>
- </member>
- <member name="M:Npgsql.Util.ResettableCancellationTokenSource.Reset(System.Threading.CancellationToken)">
- <summary>
- Reset the wrapper to contain a unstarted and uncancelled <see cref="T:System.Threading.CancellationTokenSource"/>
- in order make sure the next call to <see cref="M:Npgsql.Util.ResettableCancellationTokenSource.Start(System.Threading.CancellationToken)"/> will not invalidate
- the cancellation token.
- </summary>
- <param name="cancellationToken">
- An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
- </param>
- <returns>The <see cref="T:System.Threading.CancellationToken"/> from the wrapped <see cref="T:System.Threading.CancellationTokenSource"/></returns>
- </member>
- <member name="M:Npgsql.Util.ResettableCancellationTokenSource.ResetCts">
- <summary>
- Reset the wrapper to contain a unstarted and uncancelled <see cref="T:System.Threading.CancellationTokenSource"/>
- in order make sure the next call to <see cref="M:Npgsql.Util.ResettableCancellationTokenSource.Start(System.Threading.CancellationToken)"/> will not invalidate
- the cancellation token.
- </summary>
- </member>
- <member name="M:Npgsql.Util.ResettableCancellationTokenSource.Stop">
- <summary>
- Set the timeout on the wrapped <see cref="T:System.Threading.CancellationTokenSource"/>
- to <see cref="F:System.Threading.Timeout.InfiniteTimeSpan"/>
- </summary>
- <remarks>
- <see cref="P:Npgsql.Util.ResettableCancellationTokenSource.IsCancellationRequested"/> can still arrive at a state
- where it's value is <see langword="true"/> if the <see cref="T:System.Threading.CancellationToken"/>
- passed to <see cref="M:Npgsql.Util.ResettableCancellationTokenSource.Start(System.Threading.CancellationToken)"/> gets a cancellation request.
- If this is the case it will be resolved upon the next call to <see cref="M:Npgsql.Util.ResettableCancellationTokenSource.Start(System.Threading.CancellationToken)"/>
- or <see cref="M:Npgsql.Util.ResettableCancellationTokenSource.Reset(System.Threading.CancellationToken)"/>. Calling <see cref="M:Npgsql.Util.ResettableCancellationTokenSource.Stop"/> multiple times or without calling
- <see cref="M:Npgsql.Util.ResettableCancellationTokenSource.Start(System.Threading.CancellationToken)"/> first will do no any harm (besides eating a tiny amount of CPU cycles).
- </remarks>
- </member>
- <member name="M:Npgsql.Util.ResettableCancellationTokenSource.Cancel">
- <summary>
- Cancel the wrapped <see cref="T:System.Threading.CancellationTokenSource"/>
- </summary>
- </member>
- <member name="M:Npgsql.Util.ResettableCancellationTokenSource.CancelAfter(System.Int32)">
- <summary>
- Cancel the wrapped <see cref="T:System.Threading.CancellationTokenSource"/> after delay
- </summary>
- </member>
- <member name="P:Npgsql.Util.ResettableCancellationTokenSource.Token">
- <summary>
- The <see cref="T:System.Threading.CancellationToken"/> from the wrapped
- <see cref="T:System.Threading.CancellationTokenSource"/> .
- </summary>
- <remarks>
- The token is only valid after calling <see cref="M:Npgsql.Util.ResettableCancellationTokenSource.Start(System.Threading.CancellationToken)"/>
- and before calling <see cref="M:Npgsql.Util.ResettableCancellationTokenSource.Start(System.Threading.CancellationToken)"/> the next time.
- Otherwise you may end up with a token that has already been
- cancelled or belongs to a cancellation token source that has
- been disposed.
- </remarks>
- </member>
- <member name="M:Npgsql.Util.VersionExtensions.IsGreaterOrEqual(System.Version,System.Int32,System.Int32)">
- <summary>
- Allocation free helper function to find if version is greater than expected
- </summary>
- </member>
- <member name="T:Npgsql.VolatileResourceManager">
- <summary>
-
- </summary>
- <remarks>
- Note that a connection may be closed before its TransactionScope completes. In this case we close the NpgsqlConnection
- as usual but the connector in a special list in the pool; it will be closed only when the scope completes.
- </remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDate.Epoch">
- <summary>
- Represents the date 1970-01-01
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDate.Era">
- <summary>
- Represents the date 0001-01-01
- </summary>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlDateTime">
- <summary>
- A struct similar to .NET DateTime but capable of storing PostgreSQL's timestamp and timestamptz types.
- DateTime is capable of storing values from year 1 to 9999 at 100-nanosecond precision,
- while PostgreSQL's timestamps store values from 4713BC to 5874897AD with 1-microsecond precision.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlDateTime.ToDateTime">
- <summary>
- Cast of an <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> to a <see cref="T:System.DateTime"/>.
- </summary>
- <returns>An equivalent <see cref="T:System.DateTime"/>.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlDateTime.ToUniversalTime">
- <summary>
- Converts the value of the current <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> object to Coordinated Universal Time (UTC).
- </summary>
- <remarks>
- See the MSDN documentation for DateTime.ToUniversalTime().
- <b>Note:</b> this method <b>only</b> takes into account the time zone's base offset, and does
- <b>not</b> respect daylight savings. See https://github.com/npgsql/npgsql/pull/684 for more
- details.
- </remarks>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlDateTime.ToLocalTime">
- <summary>
- Converts the value of the current <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> object to local time.
- </summary>
- <remarks>
- See the MSDN documentation for DateTime.ToLocalTime().
- <b>Note:</b> this method <b>only</b> takes into account the time zone's base offset, and does
- <b>not</b> respect daylight savings. See https://github.com/npgsql/npgsql/pull/684 for more
- details.
- </remarks>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlDateTime.Add(NpgsqlTypes.NpgsqlTimeSpan@)">
- <summary>
- Returns a new <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> that adds the value of the specified <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to the value of this instance.
- </summary>
- <param name="value">An NpgsqlTimeSpan interval.</param>
- <returns>An object whose value is the sum of the date and time represented by this instance and the time interval represented by value.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlDateTime.Add(System.TimeSpan)">
- <summary>
- Returns a new <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> that adds the value of the specified TimeSpan to the value of this instance.
- </summary>
- <param name="value">A positive or negative time interval.</param>
- <returns>An object whose value is the sum of the date and time represented by this instance and the time interval represented by value.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlDateTime.AddYears(System.Int32)">
- <summary>
- Returns a new <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> that adds the specified number of years to the value of this instance.
- </summary>
- <param name="value">A number of years. The value parameter can be negative or positive.</param>
- <returns>An object whose value is the sum of the date and time represented by this instance and the number of years represented by value.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlDateTime.AddMonths(System.Int32)">
- <summary>
- Returns a new <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> that adds the specified number of months to the value of this instance.
- </summary>
- <param name="value">A number of months. The months parameter can be negative or positive.</param>
- <returns>An object whose value is the sum of the date and time represented by this instance and months.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlDateTime.AddDays(System.Double)">
- <summary>
- Returns a new <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> that adds the specified number of days to the value of this instance.
- </summary>
- <param name="value">A number of whole and fractional days. The value parameter can be negative or positive.</param>
- <returns>An object whose value is the sum of the date and time represented by this instance and the number of days represented by value.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlDateTime.AddHours(System.Double)">
- <summary>
- Returns a new <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> that adds the specified number of hours to the value of this instance.
- </summary>
- <param name="value">A number of whole and fractional hours. The value parameter can be negative or positive.</param>
- <returns>An object whose value is the sum of the date and time represented by this instance and the number of hours represented by value.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlDateTime.AddMinutes(System.Double)">
- <summary>
- Returns a new <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> that adds the specified number of minutes to the value of this instance.
- </summary>
- <param name="value">A number of whole and fractional minutes. The value parameter can be negative or positive.</param>
- <returns>An object whose value is the sum of the date and time represented by this instance and the number of minutes represented by value.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlDateTime.AddSeconds(System.Double)">
- <summary>
- Returns a new <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> that adds the specified number of minutes to the value of this instance.
- </summary>
- <param name="value">A number of whole and fractional minutes. The value parameter can be negative or positive.</param>
- <returns>An object whose value is the sum of the date and time represented by this instance and the number of minutes represented by value.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlDateTime.AddMilliseconds(System.Double)">
- <summary>
- Returns a new <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> that adds the specified number of milliseconds to the value of this instance.
- </summary>
- <param name="value">A number of whole and fractional milliseconds. The value parameter can be negative or positive. Note that this value is rounded to the nearest integer.</param>
- <returns>An object whose value is the sum of the date and time represented by this instance and the number of milliseconds represented by value.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlDateTime.AddTicks(System.Int64)">
- <summary>
- Returns a new <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> that adds the specified number of ticks to the value of this instance.
- </summary>
- <param name="value">A number of 100-nanosecond ticks. The value parameter can be positive or negative.</param>
- <returns>An object whose value is the sum of the date and time represented by this instance and the time represented by value.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlDateTime.op_Implicit(System.DateTime)~NpgsqlTypes.NpgsqlDateTime">
- <summary>
- Implicit cast of a <see cref="T:System.DateTime"/> to an <see cref="T:NpgsqlTypes.NpgsqlDateTime"/>
- </summary>
- <param name="dateTime">A <see cref="T:System.DateTime"/></param>
- <returns>An equivalent <see cref="T:NpgsqlTypes.NpgsqlDateTime"/>.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlDateTime.op_Explicit(NpgsqlTypes.NpgsqlDateTime)~System.DateTime">
- <summary>
- Explicit cast of an <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> to a <see cref="T:System.DateTime"/>.
- </summary>
- <param name="npgsqlDateTime">An <see cref="T:NpgsqlTypes.NpgsqlDateTime"/>.</param>
- <returns>An equivalent <see cref="T:System.DateTime"/>.</returns>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlDbType">
- <summary>
- Represents a PostgreSQL data type that can be written or read to the database.
- Used in places such as <see cref="P:Npgsql.NpgsqlParameter.NpgsqlDbType"/> to unambiguously specify
- how to encode or decode values.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Bigint">
- <summary>
- Corresponds to the PostgreSQL 8-byte "bigint" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-numeric.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Double">
- <summary>
- Corresponds to the PostgreSQL 8-byte floating-point "double" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-numeric.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Integer">
- <summary>
- Corresponds to the PostgreSQL 4-byte "integer" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-numeric.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Numeric">
- <summary>
- Corresponds to the PostgreSQL arbitrary-precision "numeric" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-numeric.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Real">
- <summary>
- Corresponds to the PostgreSQL floating-point "real" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-numeric.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Smallint">
- <summary>
- Corresponds to the PostgreSQL 2-byte "smallint" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-numeric.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Money">
- <summary>
- Corresponds to the PostgreSQL "money" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-money.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Boolean">
- <summary>
- Corresponds to the PostgreSQL "boolean" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-boolean.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Box">
- <summary>
- Corresponds to the PostgreSQL geometric "box" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-geometric.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Circle">
- <summary>
- Corresponds to the PostgreSQL geometric "circle" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-geometric.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Line">
- <summary>
- Corresponds to the PostgreSQL geometric "line" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-geometric.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.LSeg">
- <summary>
- Corresponds to the PostgreSQL geometric "lseg" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-geometric.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Path">
- <summary>
- Corresponds to the PostgreSQL geometric "path" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-geometric.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Point">
- <summary>
- Corresponds to the PostgreSQL geometric "point" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-geometric.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Polygon">
- <summary>
- Corresponds to the PostgreSQL geometric "polygon" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-geometric.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Char">
- <summary>
- Corresponds to the PostgreSQL "char(n)" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-character.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Text">
- <summary>
- Corresponds to the PostgreSQL "text" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-character.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Varchar">
- <summary>
- Corresponds to the PostgreSQL "varchar" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-character.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Name">
- <summary>
- Corresponds to the PostgreSQL internal "name" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-character.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Citext">
- <summary>
- Corresponds to the PostgreSQL "citext" type for the citext module.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/citext.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.InternalChar">
- <summary>
- Corresponds to the PostgreSQL "char" type.
- </summary>
- <remarks>
- This is an internal field and should normally not be used for regular applications.
-
- See https://www.postgresql.org/docs/current/static/datatype-text.html
- </remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Bytea">
- <summary>
- Corresponds to the PostgreSQL "bytea" type, holding a raw byte string.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-binary.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Date">
- <summary>
- Corresponds to the PostgreSQL "date" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-datetime.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Time">
- <summary>
- Corresponds to the PostgreSQL "time" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-datetime.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Timestamp">
- <summary>
- Corresponds to the PostgreSQL "timestamp" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-datetime.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.TimestampTZ">
- <summary>
- Corresponds to the PostgreSQL "timestamp with time zone" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-datetime.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.TimestampTz">
- <summary>
- Corresponds to the PostgreSQL "timestamp with time zone" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-datetime.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Interval">
- <summary>
- Corresponds to the PostgreSQL "interval" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-datetime.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.TimeTZ">
- <summary>
- Corresponds to the PostgreSQL "time with time zone" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-datetime.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.TimeTz">
- <summary>
- Corresponds to the PostgreSQL "time with time zone" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-datetime.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Abstime">
- <summary>
- Corresponds to the obsolete PostgreSQL "abstime" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-datetime.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Inet">
- <summary>
- Corresponds to the PostgreSQL "inet" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-net-types.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Cidr">
- <summary>
- Corresponds to the PostgreSQL "cidr" type, a field storing an IPv4 or IPv6 network.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-net-types.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.MacAddr">
- <summary>
- Corresponds to the PostgreSQL "macaddr" type, a field storing a 6-byte physical address.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-net-types.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.MacAddr8">
- <summary>
- Corresponds to the PostgreSQL "macaddr8" type, a field storing a 6-byte or 8-byte physical address.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-net-types.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Bit">
- <summary>
- Corresponds to the PostgreSQL "bit" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-bit.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Varbit">
- <summary>
- Corresponds to the PostgreSQL "varbit" type, a field storing a variable-length string of bits.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-boolean.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.TsVector">
- <summary>
- Corresponds to the PostgreSQL "tsvector" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-textsearch.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.TsQuery">
- <summary>
- Corresponds to the PostgreSQL "tsquery" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-textsearch.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Regconfig">
- <summary>
- Corresponds to the PostgreSQL "regconfig" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-textsearch.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Uuid">
- <summary>
- Corresponds to the PostgreSQL "uuid" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-uuid.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Xml">
- <summary>
- Corresponds to the PostgreSQL "xml" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-xml.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Json">
- <summary>
- Corresponds to the PostgreSQL "json" type, a field storing JSON in text format.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-json.html</remarks>
- <seealso cref="F:NpgsqlTypes.NpgsqlDbType.Jsonb"/>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Jsonb">
- <summary>
- Corresponds to the PostgreSQL "jsonb" type, a field storing JSON in an optimized binary.
- format.
- </summary>
- <remarks>
- Supported since PostgreSQL 9.4.
- See https://www.postgresql.org/docs/current/static/datatype-json.html
- </remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.JsonPath">
- <summary>
- Corresponds to the PostgreSQL "jsonpath" type, a field storing JSON path in text format.
- format.
- </summary>
- <remarks>
- Supported since PostgreSQL 12.
- See https://www.postgresql.org/docs/current/datatype-json.html#DATATYPE-JSONPATH
- </remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Hstore">
- <summary>
- Corresponds to the PostgreSQL "hstore" type, a dictionary of string key-value pairs.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/hstore.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Refcursor">
- <summary>
- Corresponds to the PostgreSQL "refcursor" type.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Oidvector">
- <summary>
- Corresponds to the PostgreSQL internal "oidvector" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-oid.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Int2Vector">
- <summary>
- Corresponds to the PostgreSQL internal "int2vector" type.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Oid">
- <summary>
- Corresponds to the PostgreSQL "oid" type.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-oid.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Xid">
- <summary>
- Corresponds to the PostgreSQL "xid" type, an internal transaction identifier.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-oid.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Xid8">
- <summary>
- Corresponds to the PostgreSQL "xid8" type, an internal transaction identifier.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-oid.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Cid">
- <summary>
- Corresponds to the PostgreSQL "cid" type, an internal command identifier.
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/datatype-oid.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Regtype">
- <summary>
- Corresponds to the PostgreSQL "regtype" type, a numeric (OID) ID of a type in the pg_type table.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Tid">
- <summary>
- Corresponds to the PostgreSQL "tid" type, a tuple id identifying the physical location of a row within its table.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.PgLsn">
- <summary>
- Corresponds to the PostgreSQL "pg_lsn" type, which can be used to store LSN (Log Sequence Number) data which
- is a pointer to a location in the WAL.
- </summary>
- <remarks>
- See: https://www.postgresql.org/docs/current/datatype-pg-lsn.html and
- https://git.postgresql.org/gitweb/?p=postgresql.git;a=commit;h=7d03a83f4d0736ba869fa6f93973f7623a27038a
- </remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Unknown">
- <summary>
- A special value that can be used to send parameter values to the database without
- specifying their type, allowing the database to cast them to another value based on context.
- The value will be converted to a string and send as text.
- </summary>
- <remarks>
- This value shouldn't ordinarily be used, and makes sense only when sending a data type
- unsupported by Npgsql.
- </remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Geometry">
- <summary>
- The geometry type for PostgreSQL spatial extension PostGIS.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Geography">
- <summary>
- The geography (geodetic) type for PostgreSQL spatial extension PostGIS.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.LTree">
- <summary>
- The PostgreSQL ltree type, each value is a label path "a.label.tree.value", forming a tree in a set.
- </summary>
- <remarks>See http://www.postgresql.org/docs/current/static/ltree.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.LQuery">
- <summary>
- The PostgreSQL lquery type for PostgreSQL extension ltree
- </summary>
- <remarks>See http://www.postgresql.org/docs/current/static/ltree.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.LTxtQuery">
- <summary>
- The PostgreSQL ltxtquery type for PostgreSQL extension ltree
- </summary>
- <remarks>See http://www.postgresql.org/docs/current/static/ltree.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.IntegerRange">
- <summary>
- Corresponds to the PostgreSQL "int4range" type.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.BigIntRange">
- <summary>
- Corresponds to the PostgreSQL "int8range" type.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.NumericRange">
- <summary>
- Corresponds to the PostgreSQL "numrange" type.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.TimestampRange">
- <summary>
- Corresponds to the PostgreSQL "tsrange" type.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.TimestampTzRange">
- <summary>
- Corresponds to the PostgreSQL "tstzrange" type.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.DateRange">
- <summary>
- Corresponds to the PostgreSQL "daterange" type.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.IntegerMultirange">
- <summary>
- Corresponds to the PostgreSQL "int4multirange" type.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.BigIntMultirange">
- <summary>
- Corresponds to the PostgreSQL "int8multirange" type.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.NumericMultirange">
- <summary>
- Corresponds to the PostgreSQL "nummultirange" type.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.TimestampMultirange">
- <summary>
- Corresponds to the PostgreSQL "tsmultirange" type.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.TimestampTzMultirange">
- <summary>
- Corresponds to the PostgreSQL "tstzmultirange" type.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.DateMultirange">
- <summary>
- Corresponds to the PostgreSQL "datemultirange" type.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Array">
- <summary>
- Corresponds to the PostgreSQL "array" type, a variable-length multidimensional array of
- another type. This value must be combined with another value from <see cref="T:NpgsqlTypes.NpgsqlDbType"/>
- via a bit OR (e.g. NpgsqlDbType.Array | NpgsqlDbType.Integer)
- </summary>
- <remarks>See https://www.postgresql.org/docs/current/static/arrays.html</remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Range">
- <summary>
- Corresponds to the PostgreSQL "range" type, continuous range of values of specific type.
- This value must be combined with another value from <see cref="T:NpgsqlTypes.NpgsqlDbType"/>
- via a bit OR (e.g. NpgsqlDbType.Range | NpgsqlDbType.Integer)
- </summary>
- <remarks>
- Supported since PostgreSQL 9.2.
- See https://www.postgresql.org/docs/current/static/rangetypes.html
- </remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlDbType.Multirange">
- <summary>
- Corresponds to the PostgreSQL "multirange" type, continuous range of values of specific type.
- This value must be combined with another value from <see cref="T:NpgsqlTypes.NpgsqlDbType"/>
- via a bit OR (e.g. NpgsqlDbType.Multirange | NpgsqlDbType.Integer)
- </summary>
- <remarks>
- Supported since PostgreSQL 14.
- See https://www.postgresql.org/docs/current/static/rangetypes.html
- </remarks>
- </member>
- <member name="T:NpgsqlTypes.BuiltInPostgresType">
- <summary>
- Represents a built-in PostgreSQL type as it appears in pg_type, including its name and OID.
- Extension types with variable OIDs are not represented.
- </summary>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlInterval">
- <summary>
- A raw representation of the PostgreSQL interval datatype. Use only when <see cref="T:System.TimeSpan" /> or NodaTime
- <a href="https://nodatime.org/3.0.x/api/NodaTime.Period.html">Period</a> do not have sufficient range to handle your values.
- </summary>
- <remarks>
- <p>
- See https://www.postgresql.org/docs/current/static/datatype-geometric.html.
- </p>
- <p>
- Do not use this type unless you have to: prefer <see cref="T:System.TimeSpan" /> or NodaTime
- <a href="https://nodatime.org/3.0.x/api/NodaTime.Period.html">Period</a> when possible.
- </p>
- </remarks>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlInterval.#ctor(System.Int32,System.Int32,System.Int64)">
- <summary>
- Constructs an <see cref="T:NpgsqlTypes.NpgsqlInterval"/>.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlInterval.Months">
- <summary>
- Months and years, after time for alignment.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlInterval.Days">
- <summary>
- Days, after time for alignment.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlInterval.Time">
- <summary>
- All time units other than days, months and years.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlInterval.Equals(NpgsqlTypes.NpgsqlInterval)">
- <inheritdoc />
- </member>
- <member name="M:NpgsqlTypes.NpgsqlInterval.Equals(System.Object)">
- <inheritdoc />
- </member>
- <member name="M:NpgsqlTypes.NpgsqlInterval.GetHashCode">
- <inheritdoc />
- </member>
- <member name="T:NpgsqlTypes.NpgsqlLogSequenceNumber">
- <summary>
- Wraps a PostgreSQL Write-Ahead Log Sequence Number (see: https://www.postgresql.org/docs/current/datatype-pg-lsn.html)
- </summary>
- <remarks>
- Log Sequence Numbers are a fundamental concept of the PostgreSQL Write-Ahead Log and by that of
- PostgreSQL replication. See https://www.postgresql.org/docs/current/wal-internals.html for what they represent.
-
- This struct provides conversions from/to <see cref="T:System.String"/> and <see cref="T:System.UInt64"/> and beyond that tries to port
- the methods and operators in https://git.postgresql.org/gitweb/?p=postgresql.git;a=blob;f=src/backend/utils/adt/pg_lsn.c
- but nothing more.
- </remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlLogSequenceNumber.Invalid">
- <summary>
- Zero is used indicate an invalid Log Sequence Number. No XLOG record can begin at zero.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.#ctor(System.UInt64)">
- <summary>
- Initializes a new instance of <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/>.
- </summary>
- <param name="value">The value to wrap.</param>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.Equals(NpgsqlTypes.NpgsqlLogSequenceNumber)">
- <summary>
- Returns a value indicating whether this instance is equal to a specified <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/>
- instance.
- </summary>
- <param name="other">A <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance to compare to this instance.</param>
- <returns><see langword="true" /> if the current instance is equal to the value parameter;
- otherwise, <see langword="false" />.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.CompareTo(NpgsqlTypes.NpgsqlLogSequenceNumber)">
- <summary>
- Compares this instance to a specified <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> and returns an indication of their
- relative values.
- </summary>
- <param name="value">A <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance to compare to this instance.</param>
- <returns>A signed number indicating the relative values of this instance and <paramref name="value" />.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.Equals(System.Object)">
- <summary>
- Returns a value indicating whether this instance is equal to a specified object.
- </summary>
- <param name="obj">An object to compare to this instance</param>
- <returns><see langword="true" /> if the current instance is equal to the value parameter;
- otherwise, <see langword="false" />.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.GetHashCode">
- <summary>
- Returns the hash code for this instance.
- </summary>
- <returns>A 32-bit signed integer hash code.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.ToString">
- <summary>
- Converts the numeric value of this instance to its equivalent string representation.
- </summary>
- <returns>The string representation of the value of this instance, consisting of two hexadecimal numbers of
- up to 8 digits each, separated by a slash</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.Parse(System.String)">
- <summary>
- Converts the string representation of a Log Sequence Number to a <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance.
- </summary>
- <param name="s">A string that represents the Log Sequence Number to convert.</param>
- <returns>
- A <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> equivalent to the Log Sequence Number specified in <paramref name="s" />.
- </returns>
- <exception cref="T:System.ArgumentNullException">The <paramref name="s" /> parameter is <see langword="null"/>.</exception>
- <exception cref="T:System.OverflowException">
- The <paramref name="s" /> parameter represents a number less than <see cref="F:System.UInt64.MinValue"/> or greater than
- <see cref="F:System.UInt64.MaxValue"/>.
- </exception>
- <exception cref="T:System.FormatException">The <paramref name="s" /> parameter is not in the right format.</exception>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.Parse(System.ReadOnlySpan{System.Char})">
- <summary>
- Converts the span representation of a Log Sequence Number to a <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance.
- </summary>
- <param name="s">A span containing the characters that represent the Log Sequence Number to convert.</param>
- <returns>
- A <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> equivalent to the Log Sequence Number specified in <paramref name="s" />.
- </returns>
- <exception cref="T:System.OverflowException">
- The <paramref name="s" /> parameter represents a number less than <see cref="F:System.UInt64.MinValue"/> or greater than
- <see cref="F:System.UInt64.MaxValue"/>.
- </exception>
- <exception cref="T:System.FormatException">The <paramref name="s" /> parameter is not in the right format.</exception>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.TryParse(System.String,NpgsqlTypes.NpgsqlLogSequenceNumber@)">
- <summary>
- Tries to convert the string representation of a Log Sequence Number to an <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/>
- instance. A return value indicates whether the conversion succeeded or failed.
- </summary>
- <param name="s">A string that represents the Log Sequence Number to convert.</param>
- <param name="result">
- When this method returns, contains a <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance equivalent to the Log Sequence
- Number contained in <paramref name="s"/>, if the conversion succeeded, or the default value for
- <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> (<c>0</c>) if the conversion failed. The conversion fails if the <paramref name="s" />
- parameter is <see langword="null"/> or <see cref="F:System.String.Empty"/>, is not in the right format, or represents a number
- less than <see cref="F:System.UInt64.MinValue"/> or greater than <see cref="F:System.UInt64.MaxValue"/>. This parameter is
- passed uninitialized; any value originally supplied in result will be overwritten.
- </param>
- <returns>
- <see langword="true" /> if <paramref name="s"/>c> was converted successfully; otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.TryParse(System.ReadOnlySpan{System.Char},NpgsqlTypes.NpgsqlLogSequenceNumber@)">
- <summary>
- Tries to convert the span representation of a Log Sequence Number to an <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/>
- instance. A return value indicates whether the conversion succeeded or failed.
- </summary>
- <param name="s">A span containing the characters that represent the Log Sequence Number to convert.</param>
- <param name="result">
- When this method returns, contains a <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance equivalent to the Log Sequence
- Number contained in <paramref name="s"/>, if the conversion succeeded, or the default value for
- <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> (<c>0</c>) if the conversion failed. The conversion fails if the <paramref name="s" />
- parameter is empty, is not in the right format, or represents a number less than
- <see cref="F:System.UInt64.MinValue"/> or greater than <see cref="F:System.UInt64.MaxValue"/>. This parameter is passed
- uninitialized; any value originally supplied in result will be overwritten.
- </param>
- <returns>
- <see langword="true" /> if <paramref name="s"/> was converted successfully; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.op_Explicit(System.UInt64)~NpgsqlTypes.NpgsqlLogSequenceNumber">
- <summary>
- Converts the value of a 64-bit unsigned integer to a <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance.
- </summary>
- <param name="value">A 64-bit unsigned integer.</param>
- <returns>A new instance of <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> initialized to <paramref name="value" />.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.op_Explicit(NpgsqlTypes.NpgsqlLogSequenceNumber)~System.UInt64">
- <summary>
- Converts the value of a <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance to a 64-bit unsigned integer value.
- </summary>
- <param name="value">A <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance</param>
- <returns>The contents of <paramref name="value" /> as 64-bit unsigned integer.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.op_Equality(NpgsqlTypes.NpgsqlLogSequenceNumber,NpgsqlTypes.NpgsqlLogSequenceNumber)">
- <summary>
- Returns a value that indicates whether two specified instances of <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> are equal.
- </summary>
- <param name="value1">The first Log Sequence Number to compare.</param>
- <param name="value2">The second Log Sequence Number to compare.</param>
- <returns>
- <see langword="true" /> if <paramref name="value1" /> equals <paramref name="value2" />; otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.op_Inequality(NpgsqlTypes.NpgsqlLogSequenceNumber,NpgsqlTypes.NpgsqlLogSequenceNumber)">
- <summary>
- Returns a value that indicates whether two specified instances of <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> are not
- equal.
- </summary>
- <param name="value1">The first Log Sequence Number to compare.</param>
- <param name="value2">The second Log Sequence Number to compare.</param>
- <returns>
- <see langword="true" /> if <paramref name="value1" /> does not equal <paramref name="value2" />; otherwise,
- <see langword="false" />.
- </returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.op_GreaterThan(NpgsqlTypes.NpgsqlLogSequenceNumber,NpgsqlTypes.NpgsqlLogSequenceNumber)">
- <summary>
- Returns a value indicating whether a specified <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance is greater than
- another specified <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance.
- </summary>
- <param name="value1">The first value to compare.</param>
- <param name="value2">The second value to compare.</param>
- <returns>
- <see langword="true" /> if <paramref name="value1" /> is greater than <paramref name="value2" />; otherwise,
- <see langword="false" />.
- </returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.op_LessThan(NpgsqlTypes.NpgsqlLogSequenceNumber,NpgsqlTypes.NpgsqlLogSequenceNumber)">
- <summary>
- Returns a value indicating whether a specified <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance is less than
- another specified <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance.
- </summary>
- <param name="value1">The first value to compare.</param>
- <param name="value2">The second value to compare.</param>
- <returns>
- <see langword="true" /> if <paramref name="value1" /> is less than <paramref name="value2" />; otherwise,
- <see langword="false" />.
- </returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.op_GreaterThanOrEqual(NpgsqlTypes.NpgsqlLogSequenceNumber,NpgsqlTypes.NpgsqlLogSequenceNumber)">
- <summary>
- Returns a value indicating whether a specified <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance is greater than or
- equal to another specified <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance.
- </summary>
- <param name="value1">The first value to compare.</param>
- <param name="value2">The second value to compare.</param>
- <returns>
- <see langword="true" /> if <paramref name="value1" /> is greater than or equal to <paramref name="value2" />;
- otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.Larger(NpgsqlTypes.NpgsqlLogSequenceNumber,NpgsqlTypes.NpgsqlLogSequenceNumber)">
- <summary>
- Returns the larger of two <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> values.
- </summary>
- <param name="value1">The first value to compare.</param>
- <param name="value2">The second value to compare.</param>
- <returns>
- The larger of the two <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> values.
- </returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.Smaller(NpgsqlTypes.NpgsqlLogSequenceNumber,NpgsqlTypes.NpgsqlLogSequenceNumber)">
- <summary>
- Returns the smaller of two <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> values.
- </summary>
- <param name="value1">The first value to compare.</param>
- <param name="value2">The second value to compare.</param>
- <returns>
- The smaller of the two <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> values.
- </returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.op_LessThanOrEqual(NpgsqlTypes.NpgsqlLogSequenceNumber,NpgsqlTypes.NpgsqlLogSequenceNumber)">
- <summary>
- Returns a value indicating whether a specified <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance is less than or
- equal to another specified <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance.
- </summary>
- <param name="value1">The first value to compare.</param>
- <param name="value2">The second value to compare.</param>
- <returns>
- <see langword="true" /> if <paramref name="value1" /> is less than or equal to <paramref name="value2" />;
- otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.op_Subtraction(NpgsqlTypes.NpgsqlLogSequenceNumber,NpgsqlTypes.NpgsqlLogSequenceNumber)">
- <summary>
- Subtracts two specified <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> values.
- </summary>
- <param name="first">The first <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> value.</param>
- <param name="second">The second <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> value.</param>
- <returns>The number of bytes separating those write-ahead log locations.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.op_Subtraction(NpgsqlTypes.NpgsqlLogSequenceNumber,System.Double)">
- <summary>
- Subtract the number of bytes from a <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance, giving a new
- <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance.
- Handles both positive and negative numbers of bytes.
- </summary>
- <param name="lsn">
- The <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance representing a write-ahead log location.
- </param>
- <param name="nbytes">The number of bytes to subtract.</param>
- <returns>A new <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance.</returns>
- <exception cref="T:System.OverflowException">
- The resulting <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance would represent a number less than
- <see cref="F:System.UInt64.MinValue"/>.
- </exception>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlLogSequenceNumber.op_Addition(NpgsqlTypes.NpgsqlLogSequenceNumber,System.Double)">
- <summary>
- Add the number of bytes to a <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance, giving a new
- <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance.
- Handles both positive and negative numbers of bytes.
- </summary>
- <param name="lsn">
- The <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance representing a write-ahead log location.
- </param>
- <param name="nbytes">The number of bytes to add.</param>
- <returns>A new <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance.</returns>
- <exception cref="T:System.OverflowException">
- The resulting <see cref="T:NpgsqlTypes.NpgsqlLogSequenceNumber"/> instance would represent a number greater than
- <see cref="F:System.UInt64.MaxValue"/>.
- </exception>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlRange`1">
- <summary>
- Represents a PostgreSQL range type.
- </summary>
- <typeparam name="T">The element type of the values in the range.</typeparam>
- <remarks>
- See: https://www.postgresql.org/docs/current/static/rangetypes.html
- </remarks>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlRange`1.EmptyLiteral">
- <summary>
- Defined by PostgreSQL to represent an empty range.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlRange`1.LowerInfinityLiteral">
- <summary>
- Defined by PostgreSQL to represent an infinite lower bound.
- Some element types may have specific handling for this value distinct from a missing or null value.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlRange`1.UpperInfinityLiteral">
- <summary>
- Defined by PostgreSQL to represent an infinite upper bound.
- Some element types may have specific handling for this value distinct from a missing or null value.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlRange`1.NullLiteral">
- <summary>
- Defined by PostgreSQL to represent an null bound.
- Some element types may have specific handling for this value distinct from an infinite or missing value.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlRange`1.LowerInclusiveBound">
- <summary>
- Defined by PostgreSQL to represent a lower inclusive bound.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlRange`1.LowerExclusiveBound">
- <summary>
- Defined by PostgreSQL to represent a lower exclusive bound.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlRange`1.UpperInclusiveBound">
- <summary>
- Defined by PostgreSQL to represent an upper inclusive bound.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlRange`1.UpperExclusiveBound">
- <summary>
- Defined by PostgreSQL to represent an upper exclusive bound.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlRange`1.BoundSeparator">
- <summary>
- Defined by PostgreSQL to separate the values for the upper and lower bounds.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlRange`1.BoundConverter">
- <summary>
- The <see cref="T:System.ComponentModel.TypeConverter"/> used by <see cref="M:NpgsqlTypes.NpgsqlRange`1.Parse(System.String)"/> to convert <see cref="T:System.String"/> bounds into <typeparamref name="T"/>.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlRange`1.HasEquatableBounds">
- <summary>
- True if <typeparamref name="T"/> implements <see cref="T:System.IEquatable`1"/>; otherwise, false.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlRange`1.Empty">
- <summary>
- Represents the empty range. This field is read-only.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlRange`1.LowerBound">
- <summary>
- The lower bound of the range. Only valid when <see cref="P:NpgsqlTypes.NpgsqlRange`1.LowerBoundInfinite"/> is false.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlRange`1.UpperBound">
- <summary>
- The upper bound of the range. Only valid when <see cref="P:NpgsqlTypes.NpgsqlRange`1.UpperBoundInfinite"/> is false.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlRange`1.Flags">
- <summary>
- The characteristics of the boundaries.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlRange`1.LowerBoundIsInclusive">
- <summary>
- True if the lower bound is part of the range (i.e. inclusive); otherwise, false.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlRange`1.UpperBoundIsInclusive">
- <summary>
- True if the upper bound is part of the range (i.e. inclusive); otherwise, false.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlRange`1.LowerBoundInfinite">
- <summary>
- True if the lower bound is indefinite (i.e. infinite or unbounded); otherwise, false.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlRange`1.UpperBoundInfinite">
- <summary>
- True if the upper bound is indefinite (i.e. infinite or unbounded); otherwise, false.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlRange`1.IsEmpty">
- <summary>
- True if the range is empty; otherwise, false.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlRange`1.#ctor(`0,`0)">
- <summary>
- Constructs an <see cref="T:NpgsqlTypes.NpgsqlRange`1"/> with inclusive and definite bounds.
- </summary>
- <param name="lowerBound">The lower bound of the range.</param>
- <param name="upperBound">The upper bound of the range.</param>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlRange`1.#ctor(`0,System.Boolean,`0,System.Boolean)">
- <summary>
- Constructs an <see cref="T:NpgsqlTypes.NpgsqlRange`1"/> with definite bounds.
- </summary>
- <param name="lowerBound">The lower bound of the range.</param>
- <param name="lowerBoundIsInclusive">True if the lower bound is is part of the range (i.e. inclusive); otherwise, false.</param>
- <param name="upperBound">The upper bound of the range.</param>
- <param name="upperBoundIsInclusive">True if the upper bound is part of the range (i.e. inclusive); otherwise, false.</param>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlRange`1.#ctor(`0,System.Boolean,System.Boolean,`0,System.Boolean,System.Boolean)">
- <summary>
- Constructs an <see cref="T:NpgsqlTypes.NpgsqlRange`1"/>.
- </summary>
- <param name="lowerBound">The lower bound of the range.</param>
- <param name="lowerBoundIsInclusive">True if the lower bound is is part of the range (i.e. inclusive); otherwise, false.</param>
- <param name="lowerBoundInfinite">True if the lower bound is indefinite (i.e. infinite or unbounded); otherwise, false.</param>
- <param name="upperBound">The upper bound of the range.</param>
- <param name="upperBoundIsInclusive">True if the upper bound is part of the range (i.e. inclusive); otherwise, false.</param>
- <param name="upperBoundInfinite">True if the upper bound is indefinite (i.e. infinite or unbounded); otherwise, false.</param>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlRange`1.#ctor(`0,`0,NpgsqlTypes.RangeFlags)">
- <summary>
- Constructs an <see cref="T:NpgsqlTypes.NpgsqlRange`1"/>.
- </summary>
- <param name="lowerBound">The lower bound of the range.</param>
- <param name="upperBound">The upper bound of the range.</param>
- <param name="flags">The characteristics of the range boundaries.</param>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlRange`1.IsEmptyRange(`0,`0,NpgsqlTypes.RangeFlags)">
- <summary>
- Attempts to determine if the range is malformed or implicitly empty.
- </summary>
- <param name="lowerBound">The lower bound of the range.</param>
- <param name="upperBound">The upper bound of the range.</param>
- <param name="flags">The characteristics of the range boundaries.</param>
- <returns>
- True if the range is implicitly empty; otherwise, false.
- </returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlRange`1.EvaluateBoundaryFlags(System.Boolean,System.Boolean,System.Boolean,System.Boolean)">
- <summary>
- Evaluates the boundary flags.
- </summary>
- <param name="lowerBoundIsInclusive">True if the lower bound is is part of the range (i.e. inclusive); otherwise, false.</param>
- <param name="lowerBoundInfinite">True if the lower bound is indefinite (i.e. infinite or unbounded); otherwise, false.</param>
- <param name="upperBoundIsInclusive">True if the upper bound is part of the range (i.e. inclusive); otherwise, false.</param>
- <param name="upperBoundInfinite">True if the upper bound is indefinite (i.e. infinite or unbounded); otherwise, false.</param>
- <returns>
- The boundary characteristics.
- </returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlRange`1.op_Equality(NpgsqlTypes.NpgsqlRange{`0},NpgsqlTypes.NpgsqlRange{`0})">
- <summary>
- Indicates whether the <see cref="T:NpgsqlTypes.NpgsqlRange`1"/> on the left is equal to the <see cref="T:NpgsqlTypes.NpgsqlRange`1"/> on the right.
- </summary>
- <param name="x">The <see cref="T:NpgsqlTypes.NpgsqlRange`1"/> on the left.</param>
- <param name="y">The <see cref="T:NpgsqlTypes.NpgsqlRange`1"/> on the right.</param>
- <returns>
- True if the <see cref="T:NpgsqlTypes.NpgsqlRange`1"/> on the left is equal to the <see cref="T:NpgsqlTypes.NpgsqlRange`1"/> on the right; otherwise, false.
- </returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlRange`1.op_Inequality(NpgsqlTypes.NpgsqlRange{`0},NpgsqlTypes.NpgsqlRange{`0})">
- <summary>
- Indicates whether the <see cref="T:NpgsqlTypes.NpgsqlRange`1"/> on the left is not equal to the <see cref="T:NpgsqlTypes.NpgsqlRange`1"/> on the right.
- </summary>
- <param name="x">The <see cref="T:NpgsqlTypes.NpgsqlRange`1"/> on the left.</param>
- <param name="y">The <see cref="T:NpgsqlTypes.NpgsqlRange`1"/> on the right.</param>
- <returns>
- True if the <see cref="T:NpgsqlTypes.NpgsqlRange`1"/> on the left is not equal to the <see cref="T:NpgsqlTypes.NpgsqlRange`1"/> on the right; otherwise, false.
- </returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlRange`1.Equals(System.Object)">
- <inheritdoc />
- </member>
- <member name="M:NpgsqlTypes.NpgsqlRange`1.Equals(NpgsqlTypes.NpgsqlRange{`0})">
- <inheritdoc />
- </member>
- <member name="M:NpgsqlTypes.NpgsqlRange`1.GetHashCode">
- <inheritdoc />
- </member>
- <member name="M:NpgsqlTypes.NpgsqlRange`1.ToString">
- <inheritdoc />
- </member>
- <member name="M:NpgsqlTypes.NpgsqlRange`1.Parse(System.String)">
- <summary>
- Parses the well-known text representation of a PostgreSQL range type into a <see cref="T:NpgsqlTypes.NpgsqlRange`1"/>.
- </summary>
- <param name="value">A PosgreSQL range type in a well-known text format.</param>
- <returns>
- The <see cref="T:NpgsqlTypes.NpgsqlRange`1"/> represented by the <paramref name="value"/>.
- </returns>
- <exception cref="T:System.FormatException">
- Malformed range literal.
- </exception>
- <exception cref="T:System.FormatException">
- Malformed range literal. Missing left parenthesis or bracket.
- </exception>
- <exception cref="T:System.FormatException">
- Malformed range literal. Missing right parenthesis or bracket.
- </exception>
- <exception cref="T:System.FormatException">
- Malformed range literal. Missing comma after lower bound.
- </exception>
- <remarks>
- See: https://www.postgresql.org/docs/current/static/rangetypes.html
- </remarks>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlRange`1.RangeTypeConverter">
- <summary>
- Represents a type converter for <see cref="T:NpgsqlTypes.NpgsqlRange`1" />.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlRange`1.RangeTypeConverter.Register">
- <summary>
- Adds a <see cref="T:System.ComponentModel.TypeConverterAttribute"/> to the closed form <see cref="T:NpgsqlTypes.NpgsqlRange`1"/>.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlRange`1.RangeTypeConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)">
- <inheritdoc />
- </member>
- <member name="M:NpgsqlTypes.NpgsqlRange`1.RangeTypeConverter.CanConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Type)">
- <inheritdoc />
- </member>
- <member name="M:NpgsqlTypes.NpgsqlRange`1.RangeTypeConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
- <inheritdoc />
- </member>
- <member name="M:NpgsqlTypes.NpgsqlRange`1.RangeTypeConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <inheritdoc />
- </member>
- <member name="T:NpgsqlTypes.RangeFlags">
- <summary>
- Represents characteristics of range type boundaries.
- </summary>
- <remarks>
- See: https://www.postgresql.org/docs/current/static/rangetypes.html
- </remarks>
- </member>
- <member name="F:NpgsqlTypes.RangeFlags.None">
- <summary>
- The default flag. The range is not empty and has boundaries that are definite and exclusive.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.RangeFlags.Empty">
- <summary>
- The range is empty. E.g. '(0,0)', 'empty'.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.RangeFlags.LowerBoundInclusive">
- <summary>
- The lower bound is inclusive. E.g. '[0,5]', '[0,5)', '[0,)'.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.RangeFlags.UpperBoundInclusive">
- <summary>
- The upper bound is inclusive. E.g. '[0,5]', '(0,5]', '(,5]'.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.RangeFlags.LowerBoundInfinite">
- <summary>
- The lower bound is infinite or indefinite. E.g. '(null,5]', '(-infinity,5]', '(,5]'.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.RangeFlags.UpperBoundInfinite">
- <summary>
- The upper bound is infinite or indefinite. E.g. '[0,null)', '[0,infinity)', '[0,)'.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.RangeFlags.Inclusive">
- <summary>
- Both the lower and upper bounds are inclusive.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.RangeFlags.Infinite">
- <summary>
- Both the lower and upper bounds are indefinite.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.RangeFlags.LowerInclusiveInfinite">
- <summary>
- The lower bound is both inclusive and indefinite. This represents an error condition.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.RangeFlags.UpperInclusiveInfinite">
- <summary>
- The upper bound is both inclusive and indefinite. This represents an error condition.
- </summary>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlTimeSpan">
- <summary>
- Represents the PostgreSQL interval datatype.
- </summary>
- <remarks>PostgreSQL differs from .NET in how it's interval type doesn't assume 24 hours in a day
- (to deal with 23- and 25-hour days caused by daylight savings adjustments) and has a concept
- of months that doesn't exist in .NET's <see cref="T:System.TimeSpan"/> class. (Neither datatype
- has any concessions for leap-seconds).
- <para>For most uses just casting to and from TimeSpan will work correctly — in particular,
- the results of subtracting one <see cref="T:System.DateTime"/> or the PostgreSQL date, time and
- timestamp types from another should be the same whether you do so in .NET or PostgreSQL —
- but if the handling of days and months in PostgreSQL is important to your application then you
- should use this class instead of <see cref="T:System.TimeSpan"/>.</para>
- <para>If you don't know whether these differences are important to your application, they
- probably arent! Just use <see cref="T:System.TimeSpan"/> and do not use this class directly ☺</para>
- <para>To avoid forcing unnecessary provider-specific concerns on users who need not be concerned
- with them a call to <see cref="M:System.Data.IDataRecord.GetValue(System.Int32)"/> on a field containing an
- <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> value will return a <see cref="T:System.TimeSpan"/> rather than an
- <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>. If you need the extra functionality of <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>
- then use <see cref="M:Npgsql.NpgsqlDataReader.GetInterval(System.Int32)"/>.</para>
- </remarks>
- <seealso cref="P:NpgsqlTypes.NpgsqlTimeSpan.Ticks"/>
- <seealso cref="M:NpgsqlTypes.NpgsqlTimeSpan.JustifyDays"/>
- <seealso cref="M:NpgsqlTypes.NpgsqlTimeSpan.JustifyMonths"/>
- <seealso cref="M:NpgsqlTypes.NpgsqlTimeSpan.Canonicalize"/>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTimeSpan.TicksPerMicrosecond">
- <summary>
- Represents the number of ticks (100ns periods) in one microsecond. This field is constant.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTimeSpan.TicksPerMillsecond">
- <summary>
- Represents the number of ticks (100ns periods) in one millisecond. This field is constant.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTimeSpan.TicksPerSecond">
- <summary>
- Represents the number of ticks (100ns periods) in one second. This field is constant.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTimeSpan.TicksPerMinute">
- <summary>
- Represents the number of ticks (100ns periods) in one minute. This field is constant.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTimeSpan.TicksPerHour">
- <summary>
- Represents the number of ticks (100ns periods) in one hour. This field is constant.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTimeSpan.TicksPerDay">
- <summary>
- Represents the number of ticks (100ns periods) in one day. This field is constant.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTimeSpan.HoursPerDay">
- <summary>
- Represents the number of hours in one day (assuming no daylight savings adjustments). This field is constant.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTimeSpan.DaysPerMonth">
- <summary>
- Represents the number of days assumed in one month if month justification or unjustifcation is performed.
- This is set to 30 for consistency with PostgreSQL. Note that this is means that month adjustments cause
- a year to be taken as 30 × 12 = 360 rather than 356/366 days.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTimeSpan.TicksPerMonth">
- <summary>
- Represents the number of ticks (100ns periods) in one day, assuming 30 days per month. <seealso cref="F:NpgsqlTypes.NpgsqlTimeSpan.DaysPerMonth"/>
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTimeSpan.MonthsPerYear">
- <summary>
- Represents the number of months in a year. This field is constant.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTimeSpan.MaxValue">
- <summary>
- Represents the maximum <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>. This field is read-only.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTimeSpan.MinValue">
- <summary>
- Represents the minimum <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>. This field is read-only.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTimeSpan.Zero">
- <summary>
- Represents the zero <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>. This field is read-only.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.#ctor(System.Int64)">
- <summary>
- Initializes a new <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to the specified number of ticks.
- </summary>
- <param name="ticks">A time period expressed in 100ns units.</param>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.#ctor(System.TimeSpan)">
- <summary>
- Initializes a new <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to hold the same time as a <see cref="T:System.TimeSpan"/>
- </summary>
- <param name="timespan">A time period expressed in a <see cref="T:System.TimeSpan"/></param>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.#ctor(System.Int32,System.Int32,System.Int64)">
- <summary>
- Initializes a new <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to the specified number of months, days
- & ticks.
- </summary>
- <param name="months">Number of months.</param>
- <param name="days">Number of days.</param>
- <param name="ticks">Number of 100ns units.</param>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Initializes a new <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to the specified number of
- days, hours, minutes & seconds.
- </summary>
- <param name="days">Number of days.</param>
- <param name="hours">Number of hours.</param>
- <param name="minutes">Number of minutes.</param>
- <param name="seconds">Number of seconds.</param>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Initializes a new <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to the specified number of
- days, hours, minutes, seconds & milliseconds.
- </summary>
- <param name="days">Number of days.</param>
- <param name="hours">Number of hours.</param>
- <param name="minutes">Number of minutes.</param>
- <param name="seconds">Number of seconds.</param>
- <param name="milliseconds">Number of milliseconds.</param>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Initializes a new <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to the specified number of
- months, days, hours, minutes, seconds & milliseconds.
- </summary>
- <param name="months">Number of months.</param>
- <param name="days">Number of days.</param>
- <param name="hours">Number of hours.</param>
- <param name="minutes">Number of minutes.</param>
- <param name="seconds">Number of seconds.</param>
- <param name="milliseconds">Number of milliseconds.</param>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Initializes a new <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to the specified number of
- years, months, days, hours, minutes, seconds & milliseconds.
- <para>Years are calculated exactly equivalent to 12 months.</para>
- </summary>
- <param name="years">Number of years.</param>
- <param name="months">Number of months.</param>
- <param name="days">Number of days.</param>
- <param name="hours">Number of hours.</param>
- <param name="minutes">Number of minutes.</param>
- <param name="seconds">Number of seconds.</param>
- <param name="milliseconds">Number of milliseconds.</param>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTimeSpan.Ticks">
- <summary>
- The total number of ticks(100ns units) contained. This is the resolution of the
- <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> type. This ignores the number of days and
- months held. If you want them included use <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.UnjustifyInterval"/> first.
- <remarks>The resolution of the PostgreSQL
- interval type is by default 1µs = 1,000 ns. It may be smaller as follows:
- <list type="number">
- <item>
- <term>interval(0)</term>
- <description>resolution of 1s (1 second)</description>
- </item>
- <item>
- <term>interval(1)</term>
- <description>resolution of 100ms = 0.1s (100 milliseconds)</description>
- </item>
- <item>
- <term>interval(2)</term>
- <description>resolution of 10ms = 0.01s (10 milliseconds)</description>
- </item>
- <item>
- <term>interval(3)</term>
- <description>resolution of 1ms = 0.001s (1 millisecond)</description>
- </item>
- <item>
- <term>interval(4)</term>
- <description>resolution of 100µs = 0.0001s (100 microseconds)</description>
- </item>
- <item>
- <term>interval(5)</term>
- <description>resolution of 10µs = 0.00001s (10 microseconds)</description>
- </item>
- <item>
- <term>interval(6) or interval</term>
- <description>resolution of 1µs = 0.000001s (1 microsecond)</description>
- </item>
- </list>
- <para>As such, if the 100-nanosecond resolution is significant to an application, a PostgreSQL interval will
- not suffice for those purposes.</para>
- <para>In more frequent cases though, the resolution of the interval suffices.
- <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> will always suffice to handle the resolution of any interval value, and upon
- writing to the database, will be rounded to the resolution used.</para>
- </remarks>
- <returns>The number of ticks in the instance.</returns>
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTimeSpan.Microseconds">
- <summary>
- Gets the number of whole microseconds held in the instance.
- <returns>An in the range [-999999, 999999].</returns>
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTimeSpan.Milliseconds">
- <summary>
- Gets the number of whole milliseconds held in the instance.
- <returns>An in the range [-999, 999].</returns>
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTimeSpan.Seconds">
- <summary>
- Gets the number of whole seconds held in the instance.
- <returns>An in the range [-59, 59].</returns>
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTimeSpan.Minutes">
- <summary>
- Gets the number of whole minutes held in the instance.
- <returns>An in the range [-59, 59].</returns>
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTimeSpan.Hours">
- <summary>
- Gets the number of whole hours held in the instance.
- <remarks>Note that this can be less than -23 or greater than 23 unless <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.JustifyDays"/>
- has been used to produce this instance.</remarks>
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTimeSpan.Days">
- <summary>
- Gets the number of days held in the instance.
- <remarks>Note that this does not pay attention to a time component with -24 or less hours or
- 24 or more hours, unless <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.JustifyDays"/> has been called to produce this instance.</remarks>
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTimeSpan.Months">
- <summary>
- Gets the number of months held in the instance.
- <remarks>Note that this does not pay attention to a day component with -30 or less days or
- 30 or more days, unless <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.JustifyMonths"/> has been called to produce this instance.</remarks>
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTimeSpan.Time">
- <summary>
- Returns a <see cref="T:System.TimeSpan"/> representing the time component of the instance.
- <remarks>Note that this may have a value beyond the range ±23:59:59.9999999 unless
- <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.JustifyDays"/> has been called to produce this instance.</remarks>
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTimeSpan.TotalTicks">
- <summary>
- The total number of ticks (100ns units) in the instance, assuming 24 hours in each day and
- 30 days in a month.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTimeSpan.TotalMicroseconds">
- <summary>
- The total number of microseconds in the instance, assuming 24 hours in each day and
- 30 days in a month.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTimeSpan.TotalMilliseconds">
- <summary>
- The total number of milliseconds in the instance, assuming 24 hours in each day and
- 30 days in a month.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTimeSpan.TotalSeconds">
- <summary>
- The total number of seconds in the instance, assuming 24 hours in each day and
- 30 days in a month.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTimeSpan.TotalMinutes">
- <summary>
- The total number of minutes in the instance, assuming 24 hours in each day and
- 30 days in a month.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTimeSpan.TotalHours">
- <summary>
- The total number of hours in the instance, assuming 24 hours in each day and
- 30 days in a month.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTimeSpan.TotalDays">
- <summary>
- The total number of days in the instance, assuming 24 hours in each day and
- 30 days in a month.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTimeSpan.TotalMonths">
- <summary>
- The total number of months in the instance, assuming 24 hours in each day and
- 30 days in a month.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.FromTicks(System.Int64)">
- <summary>
- Creates an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> from a number of ticks.
- </summary>
- <param name="ticks">The number of ticks (100ns units) in the interval.</param>
- <returns>A <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> with the given number of ticks.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.FromMicroseconds(System.Double)">
- <summary>
- Creates an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> from a number of microseconds.
- </summary>
- <param name="micro">The number of microseconds in the interval.</param>
- <returns>A <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> with the given number of microseconds.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.FromMilliseconds(System.Double)">
- <summary>
- Creates an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> from a number of milliseconds.
- </summary>
- <param name="milli">The number of milliseconds in the interval.</param>
- <returns>A <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> with the given number of milliseconds.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.FromSeconds(System.Double)">
- <summary>
- Creates an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> from a number of seconds.
- </summary>
- <param name="seconds">The number of seconds in the interval.</param>
- <returns>A <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> with the given number of seconds.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.FromMinutes(System.Double)">
- <summary>
- Creates an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> from a number of minutes.
- </summary>
- <param name="minutes">The number of minutes in the interval.</param>
- <returns>A <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> with the given number of minutes.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.FromHours(System.Double)">
- <summary>
- Creates an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> from a number of hours.
- </summary>
- <param name="hours">The number of hours in the interval.</param>
- <returns>A <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> with the given number of hours.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.FromDays(System.Double)">
- <summary>
- Creates an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> from a number of days.
- </summary>
- <param name="days">The number of days in the interval.</param>
- <returns>A <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> with the given number of days.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.FromMonths(System.Double)">
- <summary>
- Creates an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> from a number of months.
- </summary>
- <param name="months">The number of months in the interval.</param>
- <returns>A <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> with the given number of months.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.Add(NpgsqlTypes.NpgsqlTimeSpan@)">
- <summary>
- Adds another interval to this instance and returns the result.
- </summary>
- <param name="interval">An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to add to this instance.</param>
- <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> whose values are the sums of the two instances.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.Subtract(NpgsqlTypes.NpgsqlTimeSpan@)">
- <summary>
- Subtracts another interval from this instance and returns the result.
- </summary>
- <param name="interval">An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to subtract from this instance.</param>
- <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> whose values are the differences of the two instances.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.Negate">
- <summary>
- Returns an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> whose value is the negated value of this instance.
- </summary>
- <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> whose value is the negated value of this instance.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.Duration">
- <summary>
- This absolute value of this instance. In the case of some, but not all, components being negative,
- the rules used for justification are used to determine if the instance is positive or negative.
- </summary>
- <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> whose value is the absolute value of this instance.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.JustifyDays">
- <summary>
- Equivalent to PostgreSQL's justify_days function.
- </summary>
- <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> based on this one, but with any hours outside of the range [-23, 23]
- converted into days.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.UnjustifyDays">
- <summary>
- Opposite to PostgreSQL's justify_days function.
- </summary>
- <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> based on this one, but with any days converted to multiples of ±24hours.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.JustifyMonths">
- <summary>
- Equivalent to PostgreSQL's justify_months function.
- </summary>
- <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> based on this one, but with any days outside of the range [-30, 30]
- converted into months.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.UnjustifyMonths">
- <summary>
- Opposite to PostgreSQL's justify_months function.
- </summary>
- <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> based on this one, but with any months converted to multiples of ±30days.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.JustifyInterval">
- <summary>
- Equivalent to PostgreSQL's justify_interval function.
- </summary>
- <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> based on this one,
- but with any months converted to multiples of ±30days
- and then with any days converted to multiples of ±24hours</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.UnjustifyInterval">
- <summary>
- Opposite to PostgreSQL's justify_interval function.
- </summary>
- <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> based on this one, but with any months converted to multiples of ±30days and then any days converted to multiples of ±24hours;</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.Canonicalize">
- <summary>
- Produces a canonical NpgslInterval with 0 months and hours in the range of [-23, 23].
- <remarks>
- <para>
- While the fact that for many purposes, two different <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> instances could be considered
- equivalent (e.g. one with 2days, 3hours and one with 1day 27hours) there are different possible canonical forms.
- </para><para>
- E.g. we could move all excess hours into days and all excess days into months and have the most readable form,
- or we could move everything into the ticks and have the form that allows for the easiest arithmetic) the form
- chosen has two important properties that make it the best choice.
- </para><para>First, it is closest two how
- <see cref="T:System.TimeSpan"/> objects are most often represented. Second, it is compatible with results of many
- PostgreSQL functions, particularly with age() and the results of subtracting one date, time or timestamp from
- another.
- </para>
- <para>Note that the results of casting a <see cref="T:System.TimeSpan"/> to <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> is
- canonicalised.</para>
- </remarks>
- </summary>
- <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> based on this one, but with months converted to multiples of ±30days and with any hours outside of the range [-23, 23]
- converted into days.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_Implicit(System.TimeSpan)~NpgsqlTypes.NpgsqlTimeSpan">
- <summary>
- Implicit cast of a <see cref="T:System.TimeSpan"/> to an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>
- </summary>
- <param name="timespan">A <see cref="T:System.TimeSpan"/></param>
- <returns>An eqivalent, canonical, <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.ToNpgsqlTimeSpan(System.TimeSpan)">
- <summary>
- Casts a <see cref="T:System.TimeSpan"/> to an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_Explicit(NpgsqlTypes.NpgsqlTimeSpan)~System.TimeSpan">
- <summary>
- Explicit cast of an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to a <see cref="T:System.TimeSpan"/>.
- </summary>
- <param name="interval">A <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>.</param>
- <returns>An equivalent <see cref="T:System.TimeSpan"/>.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.ToTimeSpan(NpgsqlTypes.NpgsqlTimeSpan@)">
- <summary>
- Casts an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to a <see cref="T:System.TimeSpan"/>.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.Equals(NpgsqlTypes.NpgsqlTimeSpan)">
- <summary>
- Returns true if another <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> is exactly the same as this instance.
- </summary>
- <param name="other">An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> for comparison.</param>
- <returns>true if the two <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> instances are exactly the same,
- false otherwise.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.Equals(System.Object)">
- <summary>
- Returns true if another object is an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>, that is exactly the same as
- this instance
- </summary>
- <param name="obj">An <see cref="T:System.Object"/> for comparison.</param>
- <returns>true if the argument is an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> and is exactly the same
- as this one, false otherwise.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.Compare(NpgsqlTypes.NpgsqlTimeSpan,NpgsqlTypes.NpgsqlTimeSpan)">
- <summary>
- Compares two <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> instances.
- </summary>
- <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>.</param>
- <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>.</param>
- <returns>0 if the two are equal or equivalent. A value greater than zero if x is greater than y,
- a value less than zero if x is less than y.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.GetHashCode">
- <summary>
- A hash code suitable for uses with hashing algorithms.
- </summary>
- <returns>An signed integer.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.CompareTo(NpgsqlTypes.NpgsqlTimeSpan)">
- <summary>
- Compares this instance with another/
- </summary>
- <param name="other">An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare this with.</param>
- <returns>0 if the instances are equal or equivalent. A value less than zero if
- this instance is less than the argument. A value greater than zero if this instance
- is greater than the instance.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.CompareTo(System.Object)">
- <summary>
- Compares this instance with another/
- </summary>
- <param name="other">An object to compare this with.</param>
- <returns>0 if the argument is an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> and the instances are equal or equivalent.
- A value less than zero if the argument is an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> and
- this instance is less than the argument.
- A value greater than zero if the argument is an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> and this instance
- is greater than the instance.</returns>
- A value greater than zero if the argument is null.
- <exception cref="T:System.ArgumentException">The argument is not an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>.</exception>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.Parse(System.String)">
- <summary>
- Parses a <see cref="T:System.String"/> and returns a <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> instance.
- Designed to use the formats generally returned by PostgreSQL.
- </summary>
- <param name="str">The <see cref="T:System.String"/> to parse.</param>
- <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> represented by the argument.</returns>
- <exception cref="T:System.ArgumentNullException">The string was null.</exception>
- <exception cref="T:System.OverflowException">A value obtained from parsing the string exceeded the values allowed for the relevant component.</exception>
- <exception cref="T:System.FormatException">The string was not in a format that could be parsed to produce an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>.</exception>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.TryParse(System.String,NpgsqlTypes.NpgsqlTimeSpan@)">
- <summary>
- Attempt to parse a <see cref="T:System.String"/> to produce an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>.
- </summary>
- <param name="str">The <see cref="T:System.String"/> to parse.</param>
- <param name="result">(out) The <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> produced, or <see cref="F:NpgsqlTypes.NpgsqlTimeSpan.Zero"/> if the parsing failed.</param>
- <returns>true if the parsing succeeded, false otherwise.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.ToString">
- <summary>
- Create a <see cref="T:System.String"/> representation of the <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> instance.
- The format returned is of the form:
- [M mon[s]] [d day[s]] [HH:mm:ss[.f[f[f[f[f[f[f[f[f]]]]]]]]]]
- A zero <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> is represented as 00:00:00
- <remarks>
- Ticks are 100ns, Postgress resolution is only to 1µs at most. Hence we lose 1 or more decimal
- precision in storing values in the database. Despite this, this method will output that extra
- digit of precision. It's forward-compatible with any future increases in resolution up to 100ns,
- and also makes this ToString() more applicable to any other use-case.
- </remarks>
- </summary>
- <returns>The <see cref="T:System.String"/> representation.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_Addition(NpgsqlTypes.NpgsqlTimeSpan,NpgsqlTypes.NpgsqlTimeSpan)">
- <summary>
- Adds two <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> together.
- </summary>
- <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to add.</param>
- <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to add.</param>
- <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> whose values are the sum of the arguments.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_Subtraction(NpgsqlTypes.NpgsqlTimeSpan,NpgsqlTypes.NpgsqlTimeSpan)">
- <summary>
- Subtracts one <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> from another.
- </summary>
- <param name="x">The <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to subtract the other from.</param>
- <param name="y">The <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to subtract from the other.</param>
- <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> whose values are the difference of the arguments</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_Equality(NpgsqlTypes.NpgsqlTimeSpan,NpgsqlTypes.NpgsqlTimeSpan)">
- <summary>
- Returns true if two <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> are exactly the same.
- </summary>
- <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
- <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
- <returns>true if the two arguments are exactly the same, false otherwise.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_Inequality(NpgsqlTypes.NpgsqlTimeSpan,NpgsqlTypes.NpgsqlTimeSpan)">
- <summary>
- Returns false if two <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> are exactly the same.
- </summary>
- <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
- <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
- <returns>false if the two arguments are exactly the same, true otherwise.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_LessThan(NpgsqlTypes.NpgsqlTimeSpan,NpgsqlTypes.NpgsqlTimeSpan)">
- <summary>
- Compares two <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> instances to see if the first is less than the second
- </summary>
- <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
- <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
- <returns>true if the first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> is less than second, false otherwise.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_LessThanOrEqual(NpgsqlTypes.NpgsqlTimeSpan,NpgsqlTypes.NpgsqlTimeSpan)">
- <summary>
- Compares two <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> instances to see if the first is less than or equivalent to the second
- </summary>
- <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
- <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
- <returns>true if the first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> is less than or equivalent to second, false otherwise.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_GreaterThan(NpgsqlTypes.NpgsqlTimeSpan,NpgsqlTypes.NpgsqlTimeSpan)">
- <summary>
- Compares two <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> instances to see if the first is greater than the second
- </summary>
- <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
- <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
- <returns>true if the first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> is greater than second, false otherwise.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_GreaterThanOrEqual(NpgsqlTypes.NpgsqlTimeSpan,NpgsqlTypes.NpgsqlTimeSpan)">
- <summary>
- Compares two <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> instances to see if the first is greater than or equivalent the second
- </summary>
- <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
- <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
- <returns>true if the first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> is greater than or equivalent to the second, false otherwise.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_UnaryPlus(NpgsqlTypes.NpgsqlTimeSpan)">
- <summary>
- Returns the instance.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.Plus(NpgsqlTypes.NpgsqlTimeSpan@)">
- <summary>
- Returns the instance.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_UnaryNegation(NpgsqlTypes.NpgsqlTimeSpan)">
- <summary>
- Negates an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> instance.
- </summary>
- <param name="x">An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>.</param>
- <returns>The negation of the argument.</returns>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlTsQuery">
- <summary>
- Represents a PostgreSQL tsquery. This is the base class for the
- lexeme, not, or, and, and "followed by" nodes.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTsQuery.Kind">
- <summary>
- Node kind
- </summary>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlTsQuery.NodeKind">
- <summary>
- NodeKind
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTsQuery.NodeKind.Empty">
- <summary>
- Represents the empty tsquery. Should only be used at top level.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTsQuery.NodeKind.Lexeme">
- <summary>
- Lexeme
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTsQuery.NodeKind.Not">
- <summary>
- Not operator
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTsQuery.NodeKind.And">
- <summary>
- And operator
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTsQuery.NodeKind.Or">
- <summary>
- Or operator
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTsQuery.NodeKind.Phrase">
- <summary>
- "Followed by" operator
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQuery.#ctor(NpgsqlTypes.NpgsqlTsQuery.NodeKind)">
- <summary>
- Constructs an <see cref="T:NpgsqlTypes.NpgsqlTsQuery"/>.
- </summary>
- <param name="kind"></param>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQuery.Write(System.Text.StringBuilder)">
- <summary>
- Writes the tsquery in PostgreSQL's text format.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQuery.ToString">
- <summary>
- Writes the tsquery in PostgreSQL's text format.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQuery.Parse(System.String)">
- <summary>
- Parses a tsquery in PostgreSQL's text format.
- </summary>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQuery.GetHashCode">
- <inheritdoc/>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQuery.Equals(System.Object)">
- <inheritdoc/>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQuery.Equals(NpgsqlTypes.NpgsqlTsQuery)">
- <summary>
- Returns a value indicating whether this instance and a specified <see cref="T:NpgsqlTypes.NpgsqlTsQuery"/> object represent the same value.
- </summary>
- <param name="other">An object to compare to this instance.</param>
- <returns><see langword="true"/> if g is equal to this instance; otherwise, <see langword="false"/>.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQuery.op_Equality(NpgsqlTypes.NpgsqlTsQuery,NpgsqlTypes.NpgsqlTsQuery)">
- <summary>
- Indicates whether the values of two specified <see cref="T:NpgsqlTypes.NpgsqlTsQuery"/> objects are equal.
- </summary>
- <param name="left">The first object to compare.</param>
- <param name="right">The second object to compare.</param>
- <returns><see langword="true"/> if <paramref name="left"/> and <paramref name="right"/> are equal; otherwise, <see langword="false"/>.</returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQuery.op_Inequality(NpgsqlTypes.NpgsqlTsQuery,NpgsqlTypes.NpgsqlTsQuery)">
- <summary>
- Indicates whether the values of two specified <see cref="T:NpgsqlTypes.NpgsqlTsQuery"/> objects are not equal.
- </summary>
- <param name="left">The first object to compare.</param>
- <param name="right">The second object to compare.</param>
- <returns><see langword="true"/> if <paramref name="left"/> and <paramref name="right"/> are not equal; otherwise, <see langword="false"/>.</returns>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlTsQueryLexeme">
- <summary>
- TsQuery Lexeme node.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTsQueryLexeme.Text">
- <summary>
- Lexeme text.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTsQueryLexeme.Weights">
- <summary>
- Weights is a bitmask of the Weight enum.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTsQueryLexeme.IsPrefixSearch">
- <summary>
- Prefix search.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQueryLexeme.#ctor(System.String)">
- <summary>
- Creates a tsquery lexeme with only lexeme text.
- </summary>
- <param name="text">Lexeme text.</param>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQueryLexeme.#ctor(System.String,NpgsqlTypes.NpgsqlTsQueryLexeme.Weight)">
- <summary>
- Creates a tsquery lexeme with lexeme text and weights.
- </summary>
- <param name="text">Lexeme text.</param>
- <param name="weights">Bitmask of enum Weight.</param>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQueryLexeme.#ctor(System.String,NpgsqlTypes.NpgsqlTsQueryLexeme.Weight,System.Boolean)">
- <summary>
- Creates a tsquery lexeme with lexeme text, weights and prefix search flag.
- </summary>
- <param name="text">Lexeme text.</param>
- <param name="weights">Bitmask of enum Weight.</param>
- <param name="isPrefixSearch">Is prefix search?</param>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlTsQueryLexeme.Weight">
- <summary>
- Weight enum, can be OR'ed together.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTsQueryLexeme.Weight.None">
- <summary>
- None
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTsQueryLexeme.Weight.D">
- <summary>
- D
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTsQueryLexeme.Weight.C">
- <summary>
- C
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTsQueryLexeme.Weight.B">
- <summary>
- B
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTsQueryLexeme.Weight.A">
- <summary>
- A
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQueryLexeme.Equals(NpgsqlTypes.NpgsqlTsQuery)">
- <inheritdoc/>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQueryLexeme.GetHashCode">
- <inheritdoc/>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlTsQueryNot">
- <summary>
- TsQuery Not node.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTsQueryNot.Child">
- <summary>
- Child node
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQueryNot.#ctor(NpgsqlTypes.NpgsqlTsQuery)">
- <summary>
- Creates a not operator, with a given child node.
- </summary>
- <param name="child"></param>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQueryNot.Equals(NpgsqlTypes.NpgsqlTsQuery)">
- <inheritdoc/>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQueryNot.GetHashCode">
- <inheritdoc/>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlTsQueryBinOp">
- <summary>
- Base class for TsQuery binary operators (& and |).
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTsQueryBinOp.Left">
- <summary>
- Left child
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTsQueryBinOp.Right">
- <summary>
- Right child
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQueryBinOp.#ctor(NpgsqlTypes.NpgsqlTsQuery.NodeKind,NpgsqlTypes.NpgsqlTsQuery,NpgsqlTypes.NpgsqlTsQuery)">
- <summary>
- Constructs a <see cref="T:NpgsqlTypes.NpgsqlTsQueryBinOp"/>.
- </summary>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlTsQueryAnd">
- <summary>
- TsQuery And node.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQueryAnd.#ctor(NpgsqlTypes.NpgsqlTsQuery,NpgsqlTypes.NpgsqlTsQuery)">
- <summary>
- Creates an and operator, with two given child nodes.
- </summary>
- <param name="left"></param>
- <param name="right"></param>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQueryAnd.Equals(NpgsqlTypes.NpgsqlTsQuery)">
- <inheritdoc/>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQueryAnd.GetHashCode">
- <inheritdoc/>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlTsQueryOr">
- <summary>
- TsQuery Or Node.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQueryOr.#ctor(NpgsqlTypes.NpgsqlTsQuery,NpgsqlTypes.NpgsqlTsQuery)">
- <summary>
- Creates an or operator, with two given child nodes.
- </summary>
- <param name="left"></param>
- <param name="right"></param>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQueryOr.Equals(NpgsqlTypes.NpgsqlTsQuery)">
- <inheritdoc/>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQueryOr.GetHashCode">
- <inheritdoc/>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlTsQueryFollowedBy">
- <summary>
- TsQuery "Followed by" Node.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTsQueryFollowedBy.Distance">
- <summary>
- The distance between the 2 nodes, in lexemes.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQueryFollowedBy.#ctor(NpgsqlTypes.NpgsqlTsQuery,System.Int32,NpgsqlTypes.NpgsqlTsQuery)">
- <summary>
- Creates a "followed by" operator, specifying 2 child nodes and the
- distance between them in lexemes.
- </summary>
- <param name="left"></param>
- <param name="distance"></param>
- <param name="right"></param>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQueryFollowedBy.Equals(NpgsqlTypes.NpgsqlTsQuery)">
- <inheritdoc/>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQueryFollowedBy.GetHashCode">
- <inheritdoc/>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlTsQueryEmpty">
- <summary>
- Represents an empty tsquery. Shold only be used as top node.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQueryEmpty.#ctor">
- <summary>
- Creates a tsquery that represents an empty query. Should not be used as child node.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQueryEmpty.Equals(NpgsqlTypes.NpgsqlTsQuery)">
- <inheritdoc/>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsQueryEmpty.GetHashCode">
- <inheritdoc/>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlTsVector">
- <summary>
- Represents a PostgreSQL tsvector.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsVector.Parse(System.String)">
- <summary>
- Parses a tsvector in PostgreSQL's text format.
- </summary>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTsVector.Item(System.Int32)">
- <summary>
- Returns the lexeme at a specific index
- </summary>
- <param name="index"></param>
- <returns></returns>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTsVector.Count">
- <summary>
- Gets the number of lexemes.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsVector.GetEnumerator">
- <summary>
- Returns an enumerator.
- </summary>
- <returns></returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsVector.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Returns an enumerator.
- </summary>
- <returns></returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsVector.ToString">
- <summary>
- Gets a string representation in PostgreSQL's format.
- </summary>
- <returns></returns>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlTsVector.Lexeme">
- <summary>
- Represents a lexeme. A lexeme consists of a text string and optional word entry positions.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTsVector.Lexeme.Text">
- <summary>
- Gets or sets the text.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.#ctor(System.String)">
- <summary>
- Creates a lexeme with no word entry positions.
- </summary>
- <param name="text"></param>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.#ctor(System.String,System.Collections.Generic.List{NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos})">
- <summary>
- Creates a lexeme with word entry positions.
- </summary>
- <param name="text"></param>
- <param name="wordEntryPositions"></param>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTsVector.Lexeme.Item(System.Int32)">
- <summary>
- Gets a word entry position.
- </summary>
- <param name="index"></param>
- <returns></returns>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTsVector.Lexeme.Count">
- <summary>
- Gets the number of word entry positions.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.ToString">
- <summary>
- Creates a string representation in PostgreSQL's format.
- </summary>
- <returns></returns>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos">
- <summary>
- Represents a word entry position and an optional weight.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos.#ctor(System.Int32,NpgsqlTypes.NpgsqlTsVector.Lexeme.Weight)">
- <summary>
- Creates a WordEntryPos with a given position and weight.
- </summary>
- <param name="pos">Position values can range from 1 to 16383; larger numbers are silently set to 16383.</param>
- <param name="weight">A weight labeled between A and D.</param>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos.Weight">
- <summary>
- The weight is labeled from A to D. D is the default, and not printed.
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos.Pos">
- <summary>
- The position is a 14-bit unsigned integer indicating the position in the text this lexeme occurs. Cannot be 0.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos.ToString">
- <summary>
- Prints this lexeme in PostgreSQL's format, i.e. position is followed by weight (weight is only printed if A, B or C).
- </summary>
- <returns></returns>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos.Equals(NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos)">
- <summary>
- Determines whether the specified object is equal to the current object.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos.Equals(System.Object)">
- <summary>
- Determines whether the specified object is equal to the current object.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos.GetHashCode">
- <summary>
- Gets a hash code for the current object.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos.op_Equality(NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos,NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos)">
- <summary>
- Determines whether the specified object is equal to the current object.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos.op_Inequality(NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos,NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos)">
- <summary>
- Determines whether the specified object is unequal to the current object.
- </summary>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlTsVector.Lexeme.Weight">
- <summary>
- The weight is labeled from A to D. D is the default, and not printed.
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTsVector.Lexeme.Weight.D">
- <summary>
- D, the default
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTsVector.Lexeme.Weight.C">
- <summary>
- C
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTsVector.Lexeme.Weight.B">
- <summary>
- B
- </summary>
- </member>
- <member name="F:NpgsqlTypes.NpgsqlTsVector.Lexeme.Weight.A">
- <summary>
- A
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.Equals(NpgsqlTypes.NpgsqlTsVector.Lexeme)">
- <summary>
- Determines whether the specified object is equal to the current object.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.Equals(System.Object)">
- <summary>
- Determines whether the specified object is equal to the current object.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.GetHashCode">
- <summary>
- Gets a hash code for the current object.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.op_Equality(NpgsqlTypes.NpgsqlTsVector.Lexeme,NpgsqlTypes.NpgsqlTsVector.Lexeme)">
- <summary>
- Determines whether the specified object is equal to the current object.
- </summary>
- </member>
- <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.op_Inequality(NpgsqlTypes.NpgsqlTsVector.Lexeme,NpgsqlTypes.NpgsqlTsVector.Lexeme)">
- <summary>
- Determines whether the specified object is unequal to the current object.
- </summary>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlPoint">
- <summary>
- Represents a PostgreSQL point type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-geometric.html
- </remarks>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlLine">
- <summary>
- Represents a PostgreSQL line type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-geometric.html
- </remarks>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlLSeg">
- <summary>
- Represents a PostgreSQL Line Segment type.
- </summary>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlBox">
- <summary>
- Represents a PostgreSQL box type.
- </summary>
- <remarks>
- See https://www.postgresql.org/docs/current/static/datatype-geometric.html
- </remarks>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlPath">
- <summary>
- Represents a PostgreSQL Path type.
- </summary>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlPolygon">
- <summary>
- Represents a PostgreSQL Polygon type.
- </summary>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlCircle">
- <summary>
- Represents a PostgreSQL Circle type.
- </summary>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlInet">
- <summary>
- Represents a PostgreSQL inet type, which is a combination of an IPAddress and a
- subnet mask.
- </summary>
- <remarks>
- https://www.postgresql.org/docs/current/static/datatype-net-types.html
- </remarks>
- </member>
- <member name="T:NpgsqlTypes.NpgsqlTid">
- <summary>
- Represents a PostgreSQL tid value
- </summary>
- <remarks>
- https://www.postgresql.org/docs/current/static/datatype-oid.html
- </remarks>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTid.BlockNumber">
- <summary>
- Block number
- </summary>
- </member>
- <member name="P:NpgsqlTypes.NpgsqlTid.OffsetNumber">
- <summary>
- Tuple index within block
- </summary>
- </member>
- <member name="T:NpgsqlTypes.PgNameAttribute">
- <summary>
- Indicates that this property or field correspond to a PostgreSQL field with the specified name
- </summary>
- </member>
- <member name="P:NpgsqlTypes.PgNameAttribute.PgName">
- <summary>
- The name of PostgreSQL field that corresponds to this CLR property or field
- </summary>
- </member>
- <member name="M:NpgsqlTypes.PgNameAttribute.#ctor(System.String)">
- <summary>
- Indicates that this property or field correspond to a PostgreSQL field with the specified name
- </summary>
- <param name="pgName">The name of PostgreSQL field that corresponds to this CLR property or field</param>
- </member>
- </members>
- </doc>
|