Npgsql.xml 464 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Npgsql</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Npgsql.BackendMessages.CopyDataMessage">
  8. <summary>
  9. Note that this message doesn't actually contain the data, but only the length. Data is processed
  10. directly from the connector's buffer.
  11. </summary>
  12. </member>
  13. <member name="T:Npgsql.BackendMessages.CopyDoneMessage">
  14. <remarks>
  15. Note: This message is both a frontend and a backend message
  16. </remarks>
  17. </member>
  18. <member name="T:Npgsql.BackendMessages.DataRowMessage">
  19. <summary>
  20. DataRow is special in that it does not parse the actual contents of the backend message,
  21. because in sequential mode the message will be traversed and processed sequentially by
  22. <see cref="T:Npgsql.NpgsqlSequentialDataReader"/>.
  23. </summary>
  24. </member>
  25. <member name="T:Npgsql.BackendMessages.ErrorOrNoticeMessage.ErrorFieldTypeCode">
  26. <summary>
  27. Error and notice message field codes
  28. </summary>
  29. </member>
  30. <member name="T:Npgsql.BackendMessages.RowDescriptionMessage">
  31. <summary>
  32. A RowDescription message sent from the backend.
  33. </summary>
  34. <remarks>
  35. See http://www.postgresql.org/docs/current/static/protocol-message-formats.html
  36. </remarks>
  37. </member>
  38. <member name="M:Npgsql.BackendMessages.RowDescriptionMessage.GetFieldIndex(System.String)">
  39. <summary>
  40. Given a string name, returns the field's ordinal index in the row.
  41. </summary>
  42. </member>
  43. <member name="M:Npgsql.BackendMessages.RowDescriptionMessage.TryGetFieldIndex(System.String,System.Int32@)">
  44. <summary>
  45. Given a string name, returns the field's ordinal index in the row.
  46. </summary>
  47. </member>
  48. <member name="T:Npgsql.BackendMessages.RowDescriptionMessage.InsensitiveComparer">
  49. <summary>
  50. Comparer that's case-insensitive and Kana width-insensitive
  51. </summary>
  52. </member>
  53. <member name="T:Npgsql.BackendMessages.FieldDescription">
  54. <summary>
  55. A descriptive record on a single field received from PostgreSQL.
  56. See RowDescription in http://www.postgresql.org/docs/current/static/protocol-message-formats.html
  57. </summary>
  58. </member>
  59. <member name="P:Npgsql.BackendMessages.FieldDescription.Name">
  60. <summary>
  61. The field name.
  62. </summary>
  63. </member>
  64. <member name="P:Npgsql.BackendMessages.FieldDescription.TypeOID">
  65. <summary>
  66. The object ID of the field's data type.
  67. </summary>
  68. </member>
  69. <member name="P:Npgsql.BackendMessages.FieldDescription.TypeSize">
  70. <summary>
  71. The data type size (see pg_type.typlen). Note that negative values denote variable-width types.
  72. </summary>
  73. </member>
  74. <member name="P:Npgsql.BackendMessages.FieldDescription.TypeModifier">
  75. <summary>
  76. The type modifier (see pg_attribute.atttypmod). The meaning of the modifier is type-specific.
  77. </summary>
  78. </member>
  79. <member name="P:Npgsql.BackendMessages.FieldDescription.TableOID">
  80. <summary>
  81. If the field can be identified as a column of a specific table, the object ID of the table; otherwise zero.
  82. </summary>
  83. </member>
  84. <member name="P:Npgsql.BackendMessages.FieldDescription.ColumnAttributeNumber">
  85. <summary>
  86. If the field can be identified as a column of a specific table, the attribute number of the column; otherwise zero.
  87. </summary>
  88. </member>
  89. <member name="P:Npgsql.BackendMessages.FieldDescription.FormatCode">
  90. <summary>
  91. The format code being used for the field.
  92. Currently will be zero (text) or one (binary).
  93. In a RowDescription returned from the statement variant of Describe, the format code is not yet known and will always be zero.
  94. </summary>
  95. </member>
  96. <member name="P:Npgsql.BackendMessages.FieldDescription.Handler">
  97. <summary>
  98. The Npgsql type handler assigned to handle this field.
  99. Returns <see cref="T:Npgsql.TypeHandlers.UnknownTypeHandler"/> for fields with format text.
  100. </summary>
  101. </member>
  102. <member name="P:Npgsql.BackendMessages.FieldDescription.RealHandler">
  103. <summary>
  104. The type handler resolved for this field, regardless of whether it's binary or text.
  105. </summary>
  106. </member>
  107. <member name="M:Npgsql.BackendMessages.FieldDescription.ToString">
  108. <summary>
  109. Returns a string that represents the current object.
  110. </summary>
  111. </member>
  112. <member name="T:Npgsql.IBackendMessage">
  113. <summary>
  114. Base class for all classes which represent a message sent by the PostgreSQL backend.
  115. </summary>
  116. </member>
  117. <member name="T:Npgsql.FrontendMessage">
  118. <summary>
  119. Base class for all classes which represent a message sent to the PostgreSQL backend.
  120. Concrete classes which directly inherit this represent arbitrary-length messages which can chunked.
  121. </summary>
  122. </member>
  123. <member name="M:Npgsql.FrontendMessage.Write(Npgsql.NpgsqlWriteBuffer,System.Boolean)">
  124. <param name="buf">the buffer into which to write the message.</param>
  125. <param name="async"></param>
  126. <returns>
  127. Whether there was enough space in the buffer to contain the entire message.
  128. If false, the buffer should be flushed and write should be called again.
  129. </returns>
  130. </member>
  131. <member name="P:Npgsql.FrontendMessage.ResponseMessageCount">
  132. <summary>
  133. Returns how many messages PostgreSQL is expected to send in response to this message.
  134. Used for message prepending.
  135. </summary>
  136. </member>
  137. <member name="T:Npgsql.SimpleFrontendMessage">
  138. <summary>
  139. Represents a simple frontend message which is typically small and fits well within
  140. the write buffer. The message is first queries for the number of bytes it requires,
  141. and then writes itself out.
  142. </summary>
  143. </member>
  144. <member name="P:Npgsql.SimpleFrontendMessage.Length">
  145. <summary>
  146. Returns the number of bytes needed to write this message.
  147. </summary>
  148. </member>
  149. <member name="M:Npgsql.SimpleFrontendMessage.WriteFully(Npgsql.NpgsqlWriteBuffer)">
  150. <summary>
  151. Writes the message contents into the buffer.
  152. </summary>
  153. </member>
  154. <member name="T:Npgsql.StatementType">
  155. <summary>
  156. Specifies the type of SQL statement, e.g. SELECT
  157. </summary>
  158. </member>
  159. <member name="T:Npgsql.ConnectorPool">
  160. <summary>
  161. Connection pool for PostgreSQL physical connections. Attempts to allocate connections over MaxPoolSize will
  162. block until someone releases. Implementation is completely lock-free to avoid contention, and ensure FIFO
  163. for open attempts waiting (because the pool is at capacity).
  164. </summary>
  165. </member>
  166. <member name="P:Npgsql.ConnectorPool.UserFacingConnectionString">
  167. <summary>
  168. Contains the connection string returned to the user from <see cref="P:Npgsql.NpgsqlConnection.ConnectionString"/>
  169. after the connection has been opened. Does not contain the password unless Persist Security Info=true.
  170. </summary>
  171. </member>
  172. <member name="F:Npgsql.ConnectorPool._clearCounter">
  173. <summary>
  174. Incremented every time this pool is cleared via <see cref="M:Npgsql.NpgsqlConnection.ClearPool(Npgsql.NpgsqlConnection)"/> or
  175. <see cref="M:Npgsql.NpgsqlConnection.ClearAllPools"/>. Allows us to identify connections which were
  176. created before the clear.
  177. </summary>
  178. </member>
  179. <member name="F:Npgsql.ConnectorPool.PoolSizeLimit">
  180. <summary>
  181. Maximum number of possible connections in any pool.
  182. </summary>
  183. </member>
  184. <member name="F:Npgsql.Counters.HardConnectsPerSecond">
  185. <summary>
  186. The number of connections per second that are being made to a database server.
  187. </summary>
  188. </member>
  189. <member name="F:Npgsql.Counters.HardDisconnectsPerSecond">
  190. <summary>
  191. The number of disconnects per second that are being made to a database server.
  192. </summary>
  193. </member>
  194. <member name="F:Npgsql.Counters.NumberOfActiveConnectionPools">
  195. <summary>
  196. The total number of connection pools.
  197. </summary>
  198. </member>
  199. <member name="F:Npgsql.Counters.NumberOfActiveConnections">
  200. <summary>
  201. The number of (pooled) active connections that are currently in use.
  202. </summary>
  203. </member>
  204. <member name="F:Npgsql.Counters.NumberOfFreeConnections">
  205. <summary>
  206. The number of connections available for use in the connection pools.
  207. </summary>
  208. </member>
  209. <member name="F:Npgsql.Counters.NumberOfNonPooledConnections">
  210. <summary>
  211. The number of active connections that are not pooled.
  212. </summary>
  213. </member>
  214. <member name="F:Npgsql.Counters.NumberOfPooledConnections">
  215. <summary>
  216. The number of active connections that are being managed by the connection pooling infrastructure.
  217. </summary>
  218. </member>
  219. <member name="F:Npgsql.Counters.SoftConnectsPerSecond">
  220. <summary>
  221. The number of active connections being pulled from the connection pool.
  222. </summary>
  223. </member>
  224. <member name="F:Npgsql.Counters.SoftDisconnectsPerSecond">
  225. <summary>
  226. The number of active connections that are being returned to the connection pool.
  227. </summary>
  228. </member>
  229. <member name="T:Npgsql.Counter">
  230. <summary>
  231. This class is currently a simple wrapper around System.Diagnostics.PerformanceCounter.
  232. Since these aren't supported in .NET Standard, all the ifdef'ing happens here.
  233. When an alternative performance counter API emerges for netstandard, it can be added here.
  234. </summary>
  235. </member>
  236. <member name="P:Npgsql.FrontendMessages.BindMessage.Portal">
  237. <summary>
  238. The name of the destination portal (an empty string selects the unnamed portal).
  239. </summary>
  240. </member>
  241. <member name="P:Npgsql.FrontendMessages.BindMessage.Statement">
  242. <summary>
  243. The name of the source prepared statement (an empty string selects the unnamed prepared statement).
  244. </summary>
  245. </member>
  246. <member name="P:Npgsql.FrontendMessages.CloseMessage.Name">
  247. <summary>
  248. The name of the prepared statement or portal to close (an empty string selects the unnamed prepared statement or portal).
  249. </summary>
  250. </member>
  251. <member name="P:Npgsql.FrontendMessages.CloseMessage.StatementOrPortal">
  252. <summary>
  253. Whether to close a statement or a portal
  254. </summary>
  255. </member>
  256. <member name="P:Npgsql.FrontendMessages.DescribeMessage.Name">
  257. <summary>
  258. The name of the prepared statement or portal to describe (an empty string selects the unnamed prepared statement or portal).
  259. </summary>
  260. </member>
  261. <member name="P:Npgsql.FrontendMessages.DescribeMessage.StatementOrPortal">
  262. <summary>
  263. Whether to describe a statement or a portal
  264. </summary>
  265. </member>
  266. <member name="P:Npgsql.FrontendMessages.ParseMessage.Query">
  267. <summary>
  268. The query string to be parsed.
  269. </summary>
  270. </member>
  271. <member name="P:Npgsql.FrontendMessages.ParseMessage.Statement">
  272. <summary>
  273. The name of the destination prepared statement (an empty string selects the unnamed prepared statement).
  274. </summary>
  275. </member>
  276. <member name="M:Npgsql.FrontendMessages.PasswordMessage.CreateMD5(System.String,System.String,System.Byte[])">
  277. <summary>
  278. Creates an MD5 password message.
  279. This is the password, hashed with the username as salt, and hashed again with the backend-provided
  280. salt.
  281. </summary>
  282. </member>
  283. <member name="T:Npgsql.FrontendMessages.PregeneratedMessage">
  284. <summary>
  285. A frontend message of an arbitrary type that has been pregenerated for efficiency - it is kept
  286. in byte[] form and doesn't have to be serialized for each send.
  287. </summary>
  288. </member>
  289. <member name="M:Npgsql.FrontendMessages.PregeneratedMessage.#ctor(System.Byte[],System.String,System.Int32)">
  290. <summary>
  291. Constructs a new pregenerated message.
  292. </summary>
  293. <param name="data">The data to be sent for this message, not including the 4-byte length.</param>
  294. <param name="description">Optional string form/description for debugging</param>
  295. <param name="responseMessageCount">Returns how many messages PostgreSQL is expected to send in response to this message.</param>
  296. </member>
  297. <member name="T:Npgsql.FrontendMessages.QueryMessage">
  298. <summary>
  299. A simple query message.
  300. </summary>
  301. </member>
  302. <member name="T:Npgsql.INpgsqlDatabaseInfoFactory">
  303. <summary>
  304. A factory which get generate instances of <see cref="T:Npgsql.NpgsqlDatabaseInfo"/>, which describe a database
  305. and the types it contains. When first connecting to a database, Npgsql will attempt to load information
  306. about it via this factory.
  307. </summary>
  308. </member>
  309. <member name="M:Npgsql.INpgsqlDatabaseInfoFactory.Load(Npgsql.NpgsqlConnection,Npgsql.NpgsqlTimeout,System.Boolean)">
  310. <summary>
  311. Given a connection, loads all necessary information about the connected database, e.g. its types.
  312. A factory should only handle the exact database type it was meant for, and return null otherwise.
  313. </summary>
  314. <returns>
  315. An object describing the database to which <paramref name="conn"/> is connected, or null if the
  316. database isn't of the correct type and isn't handled by this factory.
  317. </returns>
  318. </member>
  319. <member name="T:Npgsql.KerberosUsernameProvider">
  320. <summary>
  321. Launches MIT Kerberos klist and parses out the default principal from it.
  322. Caches the result.
  323. </summary>
  324. </member>
  325. <member name="T:Npgsql.Logging.ConsoleLoggingProvider">
  326. <summary>
  327. An logging provider that outputs Npgsql logging messages to standard error.
  328. </summary>
  329. </member>
  330. <member name="M:Npgsql.Logging.ConsoleLoggingProvider.#ctor(Npgsql.Logging.NpgsqlLogLevel,System.Boolean,System.Boolean)">
  331. <summary>
  332. Constructs a new <see cref="T:Npgsql.Logging.ConsoleLoggingProvider"/>
  333. </summary>
  334. <param name="minLevel">Only messages of this level of higher will be logged</param>
  335. <param name="printLevel">If true, will output the log level (e.g. WARN). Defaults to false.</param>
  336. <param name="printConnectorId">If true, will output the connector ID. Defaults to false.</param>
  337. </member>
  338. <member name="M:Npgsql.Logging.ConsoleLoggingProvider.CreateLogger(System.String)">
  339. <summary>
  340. Creates a new <see cref="T:Npgsql.Logging.ConsoleLogger"/> instance of the given name.
  341. </summary>
  342. </member>
  343. <member name="T:Npgsql.Logging.INpgsqlLoggingProvider">
  344. Used to create logger instances of the given name.
  345. </member>
  346. <member name="M:Npgsql.Logging.INpgsqlLoggingProvider.CreateLogger(System.String)">
  347. <summary>
  348. Creates a new INpgsqlLogger instance of the given name.
  349. </summary>
  350. </member>
  351. <member name="T:Npgsql.Logging.NpgsqlLogger">
  352. <summary>
  353. A generic interface for logging.
  354. </summary>
  355. </member>
  356. <member name="T:Npgsql.Logging.NpgsqlLogManager">
  357. <summary>
  358. Manages logging for Npgsql, used to set the logging provider.
  359. </summary>
  360. </member>
  361. <member name="P:Npgsql.Logging.NpgsqlLogManager.Provider">
  362. <summary>
  363. The logging provider used for logging in Npgsql.
  364. </summary>
  365. </member>
  366. <member name="P:Npgsql.Logging.NpgsqlLogManager.IsParameterLoggingEnabled">
  367. <summary>
  368. Determines whether parameter contents will be logged alongside SQL statements - this may reveal sensitive information.
  369. Defaults to false.
  370. </summary>
  371. </member>
  372. <member name="T:Npgsql.INpgsqlNameTranslator">
  373. <summary>
  374. A component which translates a CLR name (e.g. SomeClass) into a database name (e.g. some_class)
  375. according to some scheme.
  376. Used for mapping enum and composite types.
  377. </summary>
  378. </member>
  379. <member name="M:Npgsql.INpgsqlNameTranslator.TranslateTypeName(System.String)">
  380. <summary>
  381. Given a CLR type name (e.g class, struct, enum), translates its name to a database type name.
  382. </summary>
  383. </member>
  384. <member name="M:Npgsql.INpgsqlNameTranslator.TranslateMemberName(System.String)">
  385. <summary>
  386. Given a CLR member name (property or field), translates its name to a database type name.
  387. </summary>
  388. </member>
  389. <member name="T:Npgsql.NameTranslation.NpgsqlNullNameTranslator">
  390. <summary>
  391. A name translator which preserves CLR names (e.g. SomeClass) when mapping names to the database.
  392. </summary>
  393. </member>
  394. <member name="M:Npgsql.NameTranslation.NpgsqlNullNameTranslator.TranslateTypeName(System.String)">
  395. <summary>
  396. Given a CLR type name (e.g class, struct, enum), translates its name to a database type name.
  397. </summary>
  398. </member>
  399. <member name="M:Npgsql.NameTranslation.NpgsqlNullNameTranslator.TranslateMemberName(System.String)">
  400. <summary>
  401. Given a CLR member name (property or field), translates its name to a database type name.
  402. </summary>
  403. </member>
  404. <member name="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator">
  405. <summary>
  406. A name translator which converts standard CLR names (e.g. SomeClass) to snake-case database
  407. names (some_class)
  408. </summary>
  409. </member>
  410. <member name="M:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator.#ctor">
  411. <summary>
  412. Creates a new <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>.
  413. </summary>
  414. </member>
  415. <member name="M:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator.#ctor(System.Boolean)">
  416. <summary>
  417. Creates a new <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>.
  418. </summary>
  419. <param name="legacyMode">Uses the legacy naming convention if <c>true</c>, otherwise it uses the new naming convention.</param>
  420. </member>
  421. <member name="M:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator.TranslateTypeName(System.String)">
  422. <summary>
  423. Given a CLR type name (e.g class, struct, enum), translates its name to a database type name.
  424. </summary>
  425. </member>
  426. <member name="M:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator.TranslateMemberName(System.String)">
  427. <summary>
  428. Given a CLR member name (property or field), translates its name to a database type name.
  429. </summary>
  430. </member>
  431. <member name="M:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator.ConvertToSnakeCase(System.String)">
  432. <summary>
  433. Converts a string to its snake_case equivalent.
  434. </summary>
  435. <remarks>
  436. Code borrowed from Newtonsoft.Json.
  437. See https://github.com/JamesNK/Newtonsoft.Json/blob/f012ba857f36fe75b1294a210b9104130a4db4d5/Src/Newtonsoft.Json/Utilities/StringUtils.cs#L200-L276.
  438. </remarks>
  439. <param name="value">The value to convert.</param>
  440. </member>
  441. <member name="T:Npgsql.NoSynchronizationContextScope">
  442. <summary>
  443. This mechanism is used to temporarily set the current synchronization context to null while
  444. executing Npgsql code, making all await continuations execute on the thread pool. This replaces
  445. the need to place ConfigureAwait(false) everywhere, and should be used in all surface async methods,
  446. without exception.
  447. Warning: do not use this directly in async methods, use it in sync wrappers of async methods
  448. (see https://github.com/npgsql/npgsql/issues/1593)
  449. </summary>
  450. <remarks>
  451. http://stackoverflow.com/a/28307965/640325
  452. </remarks>
  453. </member>
  454. <member name="T:Npgsql.NpgsqlBinaryExporter">
  455. <summary>
  456. Provides an API for a binary COPY TO operation, a high-performance data export mechanism from
  457. a PostgreSQL table. Initiated by <see cref="M:Npgsql.NpgsqlConnection.BeginBinaryExport(System.String)"/>
  458. </summary>
  459. </member>
  460. <member name="P:Npgsql.NpgsqlBinaryExporter.NumColumns">
  461. <summary>
  462. The number of columns, as returned from the backend in the CopyInResponse.
  463. </summary>
  464. </member>
  465. <member name="M:Npgsql.NpgsqlBinaryExporter.StartRow">
  466. <summary>
  467. Starts reading a single row, must be invoked before reading any columns.
  468. </summary>
  469. <returns>
  470. The number of columns in the row. -1 if there are no further rows.
  471. Note: This will currently be the same value for all rows, but this may change in the future.
  472. </returns>
  473. </member>
  474. <member name="M:Npgsql.NpgsqlBinaryExporter.Read``1">
  475. <summary>
  476. Reads the current column, returns its value and moves ahead to the next column.
  477. If the column is null an exception is thrown.
  478. </summary>
  479. <typeparam name="T">
  480. The type of the column to be read. This must correspond to the actual type or data
  481. corruption will occur. If in doubt, use <see cref="M:Npgsql.NpgsqlBinaryExporter.Read``1(NpgsqlTypes.NpgsqlDbType)"/> to manually
  482. specify the type.
  483. </typeparam>
  484. <returns>The value of the column</returns>
  485. </member>
  486. <member name="M:Npgsql.NpgsqlBinaryExporter.Read``1(NpgsqlTypes.NpgsqlDbType)">
  487. <summary>
  488. Reads the current column, returns its value according to <paramref name="type"/> and
  489. moves ahead to the next column.
  490. If the column is null an exception is thrown.
  491. </summary>
  492. <param name="type">
  493. In some cases <typeparamref name="T"/> isn't enough to infer the data type coming in from the
  494. database. This parameter and be used to unambiguously specify the type. An example is the JSONB
  495. type, for which <typeparamref name="T"/> will be a simple string but for which
  496. <paramref name="type"/> must be specified as <see cref="F:NpgsqlTypes.NpgsqlDbType.Jsonb"/>.
  497. </param>
  498. <typeparam name="T">The .NET type of the column to be read.</typeparam>
  499. <returns>The value of the column</returns>
  500. </member>
  501. <member name="P:Npgsql.NpgsqlBinaryExporter.IsNull">
  502. <summary>
  503. Returns whether the current column is null.
  504. </summary>
  505. </member>
  506. <member name="M:Npgsql.NpgsqlBinaryExporter.Skip">
  507. <summary>
  508. Skips the current column without interpreting its value.
  509. </summary>
  510. </member>
  511. <member name="M:Npgsql.NpgsqlBinaryExporter.Cancel">
  512. <summary>
  513. Cancels an ongoing export.
  514. </summary>
  515. </member>
  516. <member name="M:Npgsql.NpgsqlBinaryExporter.Dispose">
  517. <summary>
  518. Completes that binary export and sets the connection back to idle state
  519. </summary>
  520. </member>
  521. <member name="T:Npgsql.NpgsqlBinaryImporter">
  522. <summary>
  523. Provides an API for a binary COPY FROM operation, a high-performance data import mechanism to
  524. a PostgreSQL table. Initiated by <see cref="M:Npgsql.NpgsqlConnection.BeginBinaryImport(System.String)"/>
  525. </summary>
  526. <remarks>
  527. See http://www.postgresql.org/docs/current/static/sql-copy.html.
  528. </remarks>
  529. </member>
  530. <member name="F:Npgsql.NpgsqlBinaryImporter._column">
  531. <summary>
  532. The number of columns in the current (not-yet-written) row.
  533. </summary>
  534. </member>
  535. <member name="P:Npgsql.NpgsqlBinaryImporter.NumColumns">
  536. <summary>
  537. The number of columns, as returned from the backend in the CopyInResponse.
  538. </summary>
  539. </member>
  540. <member name="M:Npgsql.NpgsqlBinaryImporter.StartRow">
  541. <summary>
  542. Starts writing a single row, must be invoked before writing any columns.
  543. </summary>
  544. </member>
  545. <member name="M:Npgsql.NpgsqlBinaryImporter.Write``1(``0)">
  546. <summary>
  547. Writes a single column in the current row.
  548. </summary>
  549. <param name="value">The value to be written</param>
  550. <typeparam name="T">
  551. The type of the column to be written. This must correspond to the actual type or data
  552. corruption will occur. If in doubt, use <see cref="M:Npgsql.NpgsqlBinaryImporter.Write``1(``0,NpgsqlTypes.NpgsqlDbType)"/> to manually
  553. specify the type.
  554. </typeparam>
  555. </member>
  556. <member name="M:Npgsql.NpgsqlBinaryImporter.Write``1(``0,NpgsqlTypes.NpgsqlDbType)">
  557. <summary>
  558. Writes a single column in the current row as type <paramref name="npgsqlDbType"/>.
  559. </summary>
  560. <param name="value">The value to be written</param>
  561. <param name="npgsqlDbType">
  562. In some cases <typeparamref name="T"/> isn't enough to infer the data type to be written to
  563. the database. This parameter and be used to unambiguously specify the type. An example is
  564. the JSONB type, for which <typeparamref name="T"/> will be a simple string but for which
  565. <paramref name="npgsqlDbType"/> must be specified as <see cref="F:NpgsqlTypes.NpgsqlDbType.Jsonb"/>.
  566. </param>
  567. <typeparam name="T">The .NET type of the column to be written.</typeparam>
  568. </member>
  569. <member name="M:Npgsql.NpgsqlBinaryImporter.Write``1(``0,System.String)">
  570. <summary>
  571. Writes a single column in the current row as type <paramref name="dataTypeName"/>.
  572. </summary>
  573. <param name="value">The value to be written</param>
  574. <param name="dataTypeName">
  575. In some cases <typeparamref name="T"/> isn't enough to infer the data type to be written to
  576. the database. This parameter and be used to unambiguously specify the type.
  577. </param>
  578. <typeparam name="T">The .NET type of the column to be written.</typeparam>
  579. </member>
  580. <member name="M:Npgsql.NpgsqlBinaryImporter.WriteNull">
  581. <summary>
  582. Writes a single null column value.
  583. </summary>
  584. </member>
  585. <member name="M:Npgsql.NpgsqlBinaryImporter.WriteRow(System.Object[])">
  586. <summary>
  587. Writes an entire row of columns.
  588. Equivalent to calling <see cref="M:Npgsql.NpgsqlBinaryImporter.StartRow"/>, followed by multiple <see cref="M:Npgsql.NpgsqlBinaryImporter.Write``1(``0)"/>
  589. on each value.
  590. </summary>
  591. <param name="values">An array of column values to be written as a single row</param>
  592. </member>
  593. <member name="M:Npgsql.NpgsqlBinaryImporter.Complete">
  594. <summary>
  595. Completes the import operation. The writer is unusable after this operation.
  596. </summary>
  597. </member>
  598. <member name="M:Npgsql.NpgsqlBinaryImporter.Dispose">
  599. <summary>
  600. Cancels that binary import and sets the connection back to idle state
  601. </summary>
  602. </member>
  603. <member name="M:Npgsql.NpgsqlBinaryImporter.Close">
  604. <summary>
  605. Completes the import process and signals to the database to write everything.
  606. </summary>
  607. </member>
  608. <member name="T:Npgsql.NpgsqlCommand">
  609. <summary>
  610. Represents a SQL statement or function (stored procedure) to execute
  611. against a PostgreSQL database. This class cannot be inherited.
  612. </summary>
  613. </member>
  614. <member name="F:Npgsql.NpgsqlCommand._connectorPreparedOn">
  615. <summary>
  616. If this command is (explicitly) prepared, references the connector on which the preparation happened.
  617. Used to detect when the connector was changed (i.e. connection open/close), meaning that the command
  618. is no longer prepared.
  619. </summary>
  620. </member>
  621. <member name="P:Npgsql.NpgsqlCommand.Statements">
  622. <summary>
  623. Returns details about each statement that this command has executed.
  624. Is only populated when an Execute* method is called.
  625. </summary>
  626. </member>
  627. <member name="M:Npgsql.NpgsqlCommand.#ctor">
  628. <summary>
  629. Initializes a new instance of the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> class.
  630. </summary>
  631. </member>
  632. <member name="M:Npgsql.NpgsqlCommand.#ctor(System.String)">
  633. <summary>
  634. Initializes a new instance of the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> class with the text of the query.
  635. </summary>
  636. <param name="cmdText">The text of the query.</param>
  637. </member>
  638. <member name="M:Npgsql.NpgsqlCommand.#ctor(System.String,Npgsql.NpgsqlConnection)">
  639. <summary>
  640. Initializes a new instance of the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> class with the text of the query and a <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see>.
  641. </summary>
  642. <param name="cmdText">The text of the query.</param>
  643. <param name="connection">A <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see> that represents the connection to a PostgreSQL server.</param>
  644. </member>
  645. <member name="M:Npgsql.NpgsqlCommand.#ctor(System.String,Npgsql.NpgsqlConnection,Npgsql.NpgsqlTransaction)">
  646. <summary>
  647. Initializes a new instance of the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> class with the text of the query, a <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see>, and the <see cref="T:Npgsql.NpgsqlTransaction">NpgsqlTransaction</see>.
  648. </summary>
  649. <param name="cmdText">The text of the query.</param>
  650. <param name="connection">A <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see> that represents the connection to a PostgreSQL server.</param>
  651. <param name="transaction">The <see cref="T:Npgsql.NpgsqlTransaction">NpgsqlTransaction</see> in which the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> executes.</param>
  652. </member>
  653. <member name="P:Npgsql.NpgsqlCommand.CommandText">
  654. <summary>
  655. Gets or sets the SQL statement or function (stored procedure) to execute at the data source.
  656. </summary>
  657. <value>The Transact-SQL statement or stored procedure to execute. The default is an empty string.</value>
  658. </member>
  659. <member name="P:Npgsql.NpgsqlCommand.CommandTimeout">
  660. <summary>
  661. Gets or sets the wait time before terminating the attempt to execute a command and generating an error.
  662. </summary>
  663. <value>The time (in seconds) to wait for the command to execute. The default value is 30 seconds.</value>
  664. </member>
  665. <member name="P:Npgsql.NpgsqlCommand.CommandType">
  666. <summary>
  667. Gets or sets a value indicating how the
  668. <see cref="P:Npgsql.NpgsqlCommand.CommandText">CommandText</see> property is to be interpreted.
  669. </summary>
  670. <value>One of the <see cref="T:System.Data.CommandType">CommandType</see> values. The default is <see cref="T:System.Data.CommandType">CommandType.Text</see>.</value>
  671. </member>
  672. <member name="P:Npgsql.NpgsqlCommand.DbConnection">
  673. <summary>
  674. DB connection.
  675. </summary>
  676. </member>
  677. <member name="P:Npgsql.NpgsqlCommand.Connection">
  678. <summary>
  679. Gets or sets the <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see>
  680. used by this instance of the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see>.
  681. </summary>
  682. <value>The connection to a data source. The default value is a null reference.</value>
  683. </member>
  684. <member name="P:Npgsql.NpgsqlCommand.DesignTimeVisible">
  685. <summary>
  686. Design time visible.
  687. </summary>
  688. </member>
  689. <member name="P:Npgsql.NpgsqlCommand.UpdatedRowSource">
  690. <summary>
  691. Gets or sets how command results are applied to the DataRow when used by the
  692. DbDataAdapter.Update(DataSet) method.
  693. </summary>
  694. <value>One of the <see cref="T:System.Data.UpdateRowSource">UpdateRowSource</see> values.</value>
  695. </member>
  696. <member name="P:Npgsql.NpgsqlCommand.IsPrepared">
  697. <summary>
  698. Returns whether this query will execute as a prepared (compiled) query.
  699. </summary>
  700. </member>
  701. <member name="P:Npgsql.NpgsqlCommand.AllResultTypesAreUnknown">
  702. <summary>
  703. Marks all of the query's result columns as either known or unknown.
  704. Unknown results column are requested them from PostgreSQL in text format, and Npgsql makes no
  705. attempt to parse them. They will be accessible as strings only.
  706. </summary>
  707. </member>
  708. <member name="P:Npgsql.NpgsqlCommand.UnknownResultTypeList">
  709. <summary>
  710. Marks the query's result columns as known or unknown, on a column-by-column basis.
  711. Unknown results column are requested them from PostgreSQL in text format, and Npgsql makes no
  712. attempt to parse them. They will be accessible as strings only.
  713. </summary>
  714. <remarks>
  715. If the query includes several queries (e.g. SELECT 1; SELECT 2), this will only apply to the first
  716. one. The rest of the queries will be fetched and parsed as usual.
  717. The array size must correspond exactly to the number of result columns the query returns, or an
  718. error will be raised.
  719. </remarks>
  720. </member>
  721. <member name="P:Npgsql.NpgsqlCommand.ObjectResultTypes">
  722. <summary>
  723. Marks result types to be used when using GetValue on a data reader, on a column-by-column basis.
  724. Used for Entity Framework 5-6 compability.
  725. Only primitive numerical types and DateTimeOffset are supported.
  726. Set the whole array or just a value to null to use default type.
  727. </summary>
  728. </member>
  729. <member name="P:Npgsql.NpgsqlCommand.State">
  730. <summary>
  731. Gets the current state of the connector
  732. </summary>
  733. </member>
  734. <member name="M:Npgsql.NpgsqlCommand.CreateDbParameter">
  735. <summary>
  736. Creates a new instance of an <see cref="T:System.Data.Common.DbParameter">DbParameter</see> object.
  737. </summary>
  738. <returns>An <see cref="T:System.Data.Common.DbParameter">DbParameter</see> object.</returns>
  739. </member>
  740. <member name="M:Npgsql.NpgsqlCommand.CreateParameter">
  741. <summary>
  742. Creates a new instance of a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object.
  743. </summary>
  744. <returns>A <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object.</returns>
  745. </member>
  746. <member name="P:Npgsql.NpgsqlCommand.DbParameterCollection">
  747. <summary>
  748. DB parameter collection.
  749. </summary>
  750. </member>
  751. <member name="P:Npgsql.NpgsqlCommand.Parameters">
  752. <summary>
  753. Gets the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see>.
  754. </summary>
  755. <value>The parameters of the SQL statement or function (stored procedure). The default is an empty collection.</value>
  756. </member>
  757. <member name="M:Npgsql.NpgsqlCommand.Prepare">
  758. <summary>
  759. Creates a server-side prepared statement on the PostgreSQL server.
  760. This will make repeated future executions of this command much faster.
  761. </summary>
  762. </member>
  763. <member name="M:Npgsql.NpgsqlCommand.PrepareAsync">
  764. <summary>
  765. Creates a server-side prepared statement on the PostgreSQL server.
  766. This will make repeated future executions of this command much faster.
  767. </summary>
  768. </member>
  769. <member name="M:Npgsql.NpgsqlCommand.PrepareAsync(System.Threading.CancellationToken)">
  770. <summary>
  771. Creates a server-side prepared statement on the PostgreSQL server.
  772. This will make repeated future executions of this command much faster.
  773. </summary>
  774. </member>
  775. <member name="M:Npgsql.NpgsqlCommand.Unprepare">
  776. <summary>
  777. Unprepares a command, closing server-side statements associated with it.
  778. Note that this only affects commands explicitly prepared with <see cref="M:Npgsql.NpgsqlCommand.Prepare"/>, not
  779. automatically prepared statements.
  780. </summary>
  781. </member>
  782. <member name="M:Npgsql.NpgsqlCommand.ExecuteNonQuery">
  783. <summary>
  784. Executes a SQL statement against the connection and returns the number of rows affected.
  785. </summary>
  786. <returns>The number of rows affected if known; -1 otherwise.</returns>
  787. </member>
  788. <member name="M:Npgsql.NpgsqlCommand.ExecuteNonQueryAsync(System.Threading.CancellationToken)">
  789. <summary>
  790. Asynchronous version of <see cref="M:Npgsql.NpgsqlCommand.ExecuteNonQuery"/>
  791. </summary>
  792. <param name="cancellationToken">The token to monitor for cancellation requests.</param>
  793. <returns>A task representing the asynchronous operation, with the number of rows affected if known; -1 otherwise.</returns>
  794. </member>
  795. <member name="M:Npgsql.NpgsqlCommand.ExecuteScalar">
  796. <summary>
  797. Executes the query, and returns the first column of the first row
  798. in the result set returned by the query. Extra columns or rows are ignored.
  799. </summary>
  800. <returns>The first column of the first row in the result set,
  801. or a null reference if the result set is empty.</returns>
  802. </member>
  803. <member name="M:Npgsql.NpgsqlCommand.ExecuteScalarAsync(System.Threading.CancellationToken)">
  804. <summary>
  805. Asynchronous version of <see cref="M:Npgsql.NpgsqlCommand.ExecuteScalar"/>
  806. </summary>
  807. <param name="cancellationToken">The token to monitor for cancellation requests.</param>
  808. <returns>A task representing the asynchronous operation, with the first column of the
  809. first row in the result set, or a null reference if the result set is empty.</returns>
  810. </member>
  811. <member name="M:Npgsql.NpgsqlCommand.ExecuteReader">
  812. <summary>
  813. Executes the CommandText against the Connection, and returns an DbDataReader.
  814. </summary>
  815. <remarks>
  816. Unlike the ADO.NET method which it replaces, this method returns a Npgsql-specific
  817. DataReader.
  818. </remarks>
  819. <returns>A DbDataReader object.</returns>
  820. </member>
  821. <member name="M:Npgsql.NpgsqlCommand.ExecuteReader(System.Data.CommandBehavior)">
  822. <summary>
  823. Executes the CommandText against the Connection, and returns an DbDataReader using one
  824. of the CommandBehavior values.
  825. </summary>
  826. <remarks>
  827. Unlike the ADO.NET method which it replaces, this method returns a Npgsql-specific
  828. DataReader.
  829. </remarks>
  830. <returns>A DbDataReader object.</returns>
  831. </member>
  832. <member name="M:Npgsql.NpgsqlCommand.ExecuteDbDataReaderAsync(System.Data.CommandBehavior,System.Threading.CancellationToken)">
  833. <summary>
  834. Executes the command text against the connection.
  835. </summary>
  836. <param name="behavior">An instance of <see cref="T:System.Data.CommandBehavior"/>.</param>
  837. <param name="cancellationToken">A task representing the operation.</param>
  838. <returns></returns>
  839. </member>
  840. <member name="M:Npgsql.NpgsqlCommand.ExecuteDbDataReader(System.Data.CommandBehavior)">
  841. <summary>
  842. Executes the command text against the connection.
  843. </summary>
  844. </member>
  845. <member name="P:Npgsql.NpgsqlCommand.DbTransaction">
  846. <summary>
  847. DB transaction.
  848. </summary>
  849. </member>
  850. <member name="P:Npgsql.NpgsqlCommand.Transaction">
  851. <summary>
  852. Gets or sets the <see cref="T:Npgsql.NpgsqlTransaction">NpgsqlTransaction</see>
  853. within which the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> executes.
  854. </summary>
  855. <value>The <see cref="T:Npgsql.NpgsqlTransaction">NpgsqlTransaction</see>.
  856. The default value is a null reference.</value>
  857. </member>
  858. <member name="M:Npgsql.NpgsqlCommand.Cancel">
  859. <summary>
  860. Attempts to cancel the execution of a <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see>.
  861. </summary>
  862. <remarks>As per the specs, no exception will be thrown by this method in case of failure</remarks>
  863. </member>
  864. <member name="M:Npgsql.NpgsqlCommand.Dispose(System.Boolean)">
  865. <summary>
  866. Releases the resources used by the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see>.
  867. </summary>
  868. </member>
  869. <member name="M:Npgsql.NpgsqlCommand.FixupRowDescription(Npgsql.BackendMessages.RowDescriptionMessage,System.Boolean)">
  870. <summary>
  871. Fixes up the text/binary flag on result columns.
  872. Since Prepare() describes a statement rather than a portal, the resulting RowDescription
  873. will have text format on all result columns. Fix that up.
  874. </summary>
  875. <remarks>
  876. Note that UnknownResultTypeList only applies to the first query, while AllResultTypesAreUnknown applies
  877. to all of them.
  878. </remarks>
  879. </member>
  880. <member name="M:Npgsql.NpgsqlCommand.System#ICloneable#Clone">
  881. <summary>
  882. Create a new command based on this one.
  883. </summary>
  884. <returns>A new NpgsqlCommand object.</returns>
  885. </member>
  886. <member name="M:Npgsql.NpgsqlCommand.Clone">
  887. <summary>
  888. Create a new command based on this one.
  889. </summary>
  890. <returns>A new NpgsqlCommand object.</returns>
  891. </member>
  892. <member name="T:Npgsql.NpgsqlCommandBuilder">
  893. <summary>
  894. This class is responsible to create database commands for automatic insert, update and delete operations.
  895. </summary>
  896. </member>
  897. <member name="M:Npgsql.NpgsqlCommandBuilder.#ctor">
  898. <summary>
  899. Initializes a new instance of the <see cref="T:Npgsql.NpgsqlCommandBuilder"/> class.
  900. </summary>
  901. </member>
  902. <member name="M:Npgsql.NpgsqlCommandBuilder.#ctor(Npgsql.NpgsqlDataAdapter)">
  903. <summary>
  904. Initializes a new instance of the <see cref="T:Npgsql.NpgsqlCommandBuilder"/> class.
  905. </summary>
  906. <param name="adapter">The adapter.</param>
  907. </member>
  908. <member name="P:Npgsql.NpgsqlCommandBuilder.QuotePrefix">
  909. <summary>
  910. 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.
  911. </summary>
  912. <returns>
  913. The beginning character or characters to use. The default is an empty string.
  914. </returns>
  915. <PermissionSet>
  916. <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" PathDiscovery="*AllFiles*" />
  917. </PermissionSet>
  918. </member>
  919. <member name="P:Npgsql.NpgsqlCommandBuilder.QuoteSuffix">
  920. <summary>
  921. 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.
  922. </summary>
  923. <returns>
  924. The ending character or characters to use. The default is an empty string.
  925. </returns>
  926. <PermissionSet>
  927. <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" PathDiscovery="*AllFiles*" />
  928. </PermissionSet>
  929. </member>
  930. <member name="M:Npgsql.NpgsqlCommandBuilder.DeriveParameters(Npgsql.NpgsqlCommand)">
  931. <summary>
  932. This method is reponsible to derive the command parameter list with values obtained from function definition.
  933. 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.
  934. Parameters name will be parameter1, parameter2, ... for CommandType.StoredProcedure and named after the placeholder for CommandType.Text
  935. </summary>
  936. <param name="command">NpgsqlCommand whose function parameters will be obtained.</param>
  937. </member>
  938. <member name="M:Npgsql.NpgsqlCommandBuilder.GetInsertCommand">
  939. <summary>
  940. Gets the automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required
  941. to perform insertions at the data source.
  942. </summary>
  943. <returns>
  944. The automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required to perform insertions.
  945. </returns>
  946. </member>
  947. <member name="M:Npgsql.NpgsqlCommandBuilder.GetInsertCommand(System.Boolean)">
  948. <summary>
  949. Gets the automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required to perform insertions
  950. at the data source, optionally using columns for parameter names.
  951. </summary>
  952. <param name="useColumnsForParameterNames">
  953. If <c>true</c>, generate parameter names matching column names, if possible.
  954. If <c>false</c>, generate @p1, @p2, and so on.
  955. </param>
  956. <returns>
  957. The automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required to perform insertions.
  958. </returns>
  959. </member>
  960. <member name="M:Npgsql.NpgsqlCommandBuilder.GetUpdateCommand">
  961. <summary>
  962. Gets the automatically generated System.Data.Common.DbCommand object required
  963. to perform updates at the data source.
  964. </summary>
  965. <returns>
  966. The automatically generated System.Data.Common.DbCommand object required to perform updates.
  967. </returns>
  968. </member>
  969. <member name="M:Npgsql.NpgsqlCommandBuilder.GetUpdateCommand(System.Boolean)">
  970. <summary>
  971. Gets the automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required to perform updates
  972. at the data source, optionally using columns for parameter names.
  973. </summary>
  974. <param name="useColumnsForParameterNames">
  975. If <c>true</c>, generate parameter names matching column names, if possible.
  976. If <c>false</c>, generate @p1, @p2, and so on.
  977. </param>
  978. <returns>
  979. The automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required to perform updates.
  980. </returns>
  981. </member>
  982. <member name="M:Npgsql.NpgsqlCommandBuilder.GetDeleteCommand">
  983. <summary>
  984. Gets the automatically generated System.Data.Common.DbCommand object required
  985. to perform deletions at the data source.
  986. </summary>
  987. <returns>
  988. The automatically generated System.Data.Common.DbCommand object required to perform deletions.
  989. </returns>
  990. </member>
  991. <member name="M:Npgsql.NpgsqlCommandBuilder.GetDeleteCommand(System.Boolean)">
  992. <summary>
  993. Gets the automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required to perform deletions
  994. at the data source, optionally using columns for parameter names.
  995. </summary>
  996. <param name="useColumnsForParameterNames">
  997. If <c>true</c>, generate parameter names matching column names, if possible.
  998. If <c>false</c>, generate @p1, @p2, and so on.
  999. </param>
  1000. <returns>
  1001. The automatically generated <see cref="T:Npgsql.NpgsqlCommand"/> object required to perform deletions.
  1002. </returns>
  1003. </member>
  1004. <member name="M:Npgsql.NpgsqlCommandBuilder.ApplyParameterInfo(System.Data.Common.DbParameter,System.Data.DataRow,System.Data.StatementType,System.Boolean)">
  1005. <summary>
  1006. Applies the parameter information.
  1007. </summary>
  1008. <param name="p">The parameter.</param>
  1009. <param name="row">The row.</param>
  1010. <param name="statementType">Type of the statement.</param>
  1011. <param name="whereClause">if set to <c>true</c> [where clause].</param>
  1012. </member>
  1013. <member name="M:Npgsql.NpgsqlCommandBuilder.GetParameterName(System.Int32)">
  1014. <summary>
  1015. Returns the name of the specified parameter in the format of @p#.
  1016. </summary>
  1017. <param name="parameterOrdinal">The number to be included as part of the parameter's name..</param>
  1018. <returns>
  1019. The name of the parameter with the specified number appended as part of the parameter name.
  1020. </returns>
  1021. </member>
  1022. <member name="M:Npgsql.NpgsqlCommandBuilder.GetParameterName(System.String)">
  1023. <summary>
  1024. Returns the full parameter name, given the partial parameter name.
  1025. </summary>
  1026. <param name="parameterName">The partial name of the parameter.</param>
  1027. <returns>
  1028. The full parameter name corresponding to the partial parameter name requested.
  1029. </returns>
  1030. </member>
  1031. <member name="M:Npgsql.NpgsqlCommandBuilder.GetParameterPlaceholder(System.Int32)">
  1032. <summary>
  1033. Returns the placeholder for the parameter in the associated SQL statement.
  1034. </summary>
  1035. <param name="parameterOrdinal">The number to be included as part of the parameter's name.</param>
  1036. <returns>
  1037. The name of the parameter with the specified number appended.
  1038. </returns>
  1039. </member>
  1040. <member name="M:Npgsql.NpgsqlCommandBuilder.SetRowUpdatingHandler(System.Data.Common.DbDataAdapter)">
  1041. <summary>
  1042. Registers the <see cref="T:Npgsql.NpgsqlCommandBuilder" /> to handle the <see cref="E:Npgsql.NpgsqlDataAdapter.RowUpdating"/> event for a <see cref="T:Npgsql.NpgsqlDataAdapter" />.
  1043. </summary>
  1044. <param name="adapter">The <see cref="T:System.Data.Common.DbDataAdapter" /> to be used for the update.</param>
  1045. </member>
  1046. <member name="M:Npgsql.NpgsqlCommandBuilder.RowUpdatingHandler(System.Object,Npgsql.NpgsqlRowUpdatingEventArgs)">
  1047. <summary>
  1048. Adds an event handler for the <see cref="E:Npgsql.NpgsqlDataAdapter.RowUpdating"/> event.
  1049. </summary>
  1050. <param name="sender">The sender</param>
  1051. <param name="e">A <see cref="T:Npgsql.NpgsqlRowUpdatingEventArgs"/> instance containing information about the event.</param>
  1052. </member>
  1053. <member name="M:Npgsql.NpgsqlCommandBuilder.QuoteIdentifier(System.String)">
  1054. <summary>
  1055. 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.
  1056. </summary>
  1057. <param name="unquotedIdentifier">The original unquoted identifier.</param>
  1058. <returns>
  1059. The quoted version of the identifier. Embedded quotes within the identifier are properly escaped.
  1060. </returns>
  1061. <PermissionSet>
  1062. <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" PathDiscovery="*AllFiles*" />
  1063. </PermissionSet>
  1064. <exception cref="T:System.ArgumentNullException">Unquoted identifier parameter cannot be null</exception>
  1065. </member>
  1066. <member name="M:Npgsql.NpgsqlCommandBuilder.UnquoteIdentifier(System.String)">
  1067. <summary>
  1068. Given a quoted identifier, returns the correct unquoted form of that identifier, including properly un-escaping any embedded quotes in the identifier.
  1069. </summary>
  1070. <param name="quotedIdentifier">The identifier that will have its embedded quotes removed.</param>
  1071. <returns>
  1072. The unquoted identifier, with embedded quotes properly un-escaped.
  1073. </returns>
  1074. <PermissionSet>
  1075. <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" PathDiscovery="*AllFiles*" />
  1076. </PermissionSet>
  1077. <exception cref="T:System.ArgumentNullException">Quoted identifier parameter cannot be null</exception>
  1078. </member>
  1079. <member name="T:Npgsql.NpgsqlConnection">
  1080. <summary>
  1081. This class represents a connection to a PostgreSQL server.
  1082. </summary>
  1083. </member>
  1084. <member name="F:Npgsql.NpgsqlConnection._userFacingConnectionString">
  1085. <summary>
  1086. The connection string, without the password after open (unless Persist Security Info=true)
  1087. </summary>
  1088. </member>
  1089. <member name="F:Npgsql.NpgsqlConnection._connectionString">
  1090. <summary>
  1091. The original connection string provided by the user, including the password.
  1092. </summary>
  1093. </member>
  1094. <member name="F:Npgsql.NpgsqlConnection.Connector">
  1095. <summary>
  1096. The connector object connected to the backend.
  1097. </summary>
  1098. </member>
  1099. <member name="P:Npgsql.NpgsqlConnection.Settings">
  1100. <summary>
  1101. The parsed connection string set by the user
  1102. </summary>
  1103. </member>
  1104. <member name="P:Npgsql.NpgsqlConnection.GlobalTypeMapper">
  1105. <summary>
  1106. The global type mapper, which contains defaults used by all new connections.
  1107. Modify mappings on this mapper to affect your entire application.
  1108. </summary>
  1109. </member>
  1110. <member name="P:Npgsql.NpgsqlConnection.TypeMapper">
  1111. <summary>
  1112. The connection-specific type mapper - all modifications affect this connection only,
  1113. and are lost when it is closed.
  1114. </summary>
  1115. </member>
  1116. <member name="F:Npgsql.NpgsqlConnection.DefaultPort">
  1117. <summary>
  1118. The default TCP/IP port for PostgreSQL.
  1119. </summary>
  1120. </member>
  1121. <member name="F:Npgsql.NpgsqlConnection.TimeoutLimit">
  1122. <summary>
  1123. Maximum value for connection timeout.
  1124. </summary>
  1125. </member>
  1126. <member name="M:Npgsql.NpgsqlConnection.#ctor">
  1127. <summary>
  1128. Initializes a new instance of the
  1129. <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see> class.
  1130. </summary>
  1131. </member>
  1132. <member name="M:Npgsql.NpgsqlConnection.#ctor(System.String)">
  1133. <summary>
  1134. Initializes a new instance of <see cref="T:Npgsql.NpgsqlConnection"/> with the given connection string.
  1135. </summary>
  1136. <param name="connectionString">The connection used to open the PostgreSQL database.</param>
  1137. </member>
  1138. <member name="M:Npgsql.NpgsqlConnection.Open">
  1139. <summary>
  1140. Opens a database connection with the property settings specified by the
  1141. <see cref="P:Npgsql.NpgsqlConnection.ConnectionString">ConnectionString</see>.
  1142. </summary>
  1143. </member>
  1144. <member name="M:Npgsql.NpgsqlConnection.OpenAsync(System.Threading.CancellationToken)">
  1145. <summary>
  1146. This is the asynchronous version of <see cref="M:Npgsql.NpgsqlConnection.Open"/>.
  1147. </summary>
  1148. <remarks>
  1149. Do not invoke other methods and properties of the <see cref="T:Npgsql.NpgsqlConnection"/> object until the returned Task is complete.
  1150. </remarks>
  1151. <param name="cancellationToken">The cancellation instruction.</param>
  1152. <returns>A task representing the asynchronous operation.</returns>
  1153. </member>
  1154. <member name="P:Npgsql.NpgsqlConnection.ConnectionString">
  1155. <summary>
  1156. Gets or sets the string used to connect to a PostgreSQL database. See the manual for details.
  1157. </summary>
  1158. <value>The connection string that includes the server name,
  1159. the database name, and other parameters needed to establish
  1160. the initial connection. The default value is an empty string.
  1161. </value>
  1162. </member>
  1163. <member name="P:Npgsql.NpgsqlConnection.Host">
  1164. <summary>
  1165. Backend server host name.
  1166. </summary>
  1167. </member>
  1168. <member name="P:Npgsql.NpgsqlConnection.Port">
  1169. <summary>
  1170. Backend server port.
  1171. </summary>
  1172. </member>
  1173. <member name="P:Npgsql.NpgsqlConnection.ConnectionTimeout">
  1174. <summary>
  1175. Gets the time to wait while trying to establish a connection
  1176. before terminating the attempt and generating an error.
  1177. </summary>
  1178. <value>The time (in seconds) to wait for a connection to open. The default value is 15 seconds.</value>
  1179. </member>
  1180. <member name="P:Npgsql.NpgsqlConnection.CommandTimeout">
  1181. <summary>
  1182. Gets the time to wait while trying to execute a command
  1183. before terminating the attempt and generating an error.
  1184. </summary>
  1185. <value>The time (in seconds) to wait for a command to complete. The default value is 20 seconds.</value>
  1186. </member>
  1187. <member name="P:Npgsql.NpgsqlConnection.Database">
  1188. <summary>
  1189. Gets the name of the current database or the database to be used after a connection is opened.
  1190. </summary>
  1191. <value>The name of the current database or the name of the database to be
  1192. used after a connection is opened. The default value is the empty string.</value>
  1193. </member>
  1194. <member name="P:Npgsql.NpgsqlConnection.DataSource">
  1195. <summary>
  1196. Gets the string identifying the database server (host and port)
  1197. </summary>
  1198. </member>
  1199. <member name="P:Npgsql.NpgsqlConnection.IntegratedSecurity">
  1200. <summary>
  1201. Whether to use Windows integrated security to log in.
  1202. </summary>
  1203. </member>
  1204. <member name="P:Npgsql.NpgsqlConnection.UserName">
  1205. <summary>
  1206. User name.
  1207. </summary>
  1208. </member>
  1209. <member name="P:Npgsql.NpgsqlConnection.FullState">
  1210. <summary>
  1211. Gets the current state of the connection.
  1212. </summary>
  1213. <value>A bitwise combination of the <see cref="T:System.Data.ConnectionState">ConnectionState</see> values. The default is <b>Closed</b>.</value>
  1214. </member>
  1215. <member name="P:Npgsql.NpgsqlConnection.State">
  1216. <summary>
  1217. Gets whether the current state of the connection is Open or Closed
  1218. </summary>
  1219. <value>ConnectionState.Open, ConnectionState.Closed or ConnectionState.Connecting</value>
  1220. </member>
  1221. <member name="M:Npgsql.NpgsqlConnection.CreateDbCommand">
  1222. <summary>
  1223. Creates and returns a <see cref="T:System.Data.Common.DbCommand">DbCommand</see>
  1224. object associated with the <see cref="T:System.Data.Common.DbConnection">IDbConnection</see>.
  1225. </summary>
  1226. <returns>A <see cref="T:System.Data.Common.DbCommand">DbCommand</see> object.</returns>
  1227. </member>
  1228. <member name="M:Npgsql.NpgsqlConnection.CreateCommand">
  1229. <summary>
  1230. Creates and returns a <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see>
  1231. object associated with the <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see>.
  1232. </summary>
  1233. <returns>A <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> object.</returns>
  1234. </member>
  1235. <member name="M:Npgsql.NpgsqlConnection.BeginDbTransaction(System.Data.IsolationLevel)">
  1236. <summary>
  1237. Begins a database transaction with the specified isolation level.
  1238. </summary>
  1239. <param name="isolationLevel">The <see cref="T:System.Data.IsolationLevel">isolation level</see> under which the transaction should run.</param>
  1240. <returns>An <see cref="T:System.Data.Common.DbTransaction">DbTransaction</see>
  1241. object representing the new transaction.</returns>
  1242. <remarks>
  1243. Currently the IsolationLevel ReadCommitted and Serializable are supported by the PostgreSQL backend.
  1244. There's no support for nested transactions.
  1245. </remarks>
  1246. </member>
  1247. <member name="M:Npgsql.NpgsqlConnection.BeginTransaction">
  1248. <summary>
  1249. Begins a database transaction.
  1250. </summary>
  1251. <returns>A <see cref="T:Npgsql.NpgsqlTransaction">NpgsqlTransaction</see>
  1252. object representing the new transaction.</returns>
  1253. <remarks>
  1254. Currently there's no support for nested transactions. Transactions created by this method will have Read Committed isolation level.
  1255. </remarks>
  1256. </member>
  1257. <member name="M:Npgsql.NpgsqlConnection.BeginTransaction(System.Data.IsolationLevel)">
  1258. <summary>
  1259. Begins a database transaction with the specified isolation level.
  1260. </summary>
  1261. <param name="level">The <see cref="T:System.Data.IsolationLevel">isolation level</see> under which the transaction should run.</param>
  1262. <returns>A <see cref="T:Npgsql.NpgsqlTransaction">NpgsqlTransaction</see>
  1263. object representing the new transaction.</returns>
  1264. <remarks>
  1265. Currently the IsolationLevel ReadCommitted and Serializable are supported by the PostgreSQL backend.
  1266. There's no support for nested transactions.
  1267. </remarks>
  1268. </member>
  1269. <member name="M:Npgsql.NpgsqlConnection.EnlistTransaction(System.Transactions.Transaction)">
  1270. <summary>
  1271. Enlist transation.
  1272. </summary>
  1273. </member>
  1274. <member name="M:Npgsql.NpgsqlConnection.Close">
  1275. <summary>
  1276. releases the connection to the database. If the connection is pooled, it will be
  1277. made available for re-use. If it is non-pooled, the actual connection will be shutdown.
  1278. </summary>
  1279. </member>
  1280. <member name="M:Npgsql.NpgsqlConnection.Dispose(System.Boolean)">
  1281. <summary>
  1282. Releases all resources used by the
  1283. <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see>.
  1284. </summary>
  1285. <param name="disposing"><b>true</b> when called from Dispose();
  1286. <b>false</b> when being called from the finalizer.</param>
  1287. </member>
  1288. <member name="E:Npgsql.NpgsqlConnection.Notice">
  1289. <summary>
  1290. Fires when PostgreSQL notices are received from PostgreSQL.
  1291. </summary>
  1292. <remarks>
  1293. PostgreSQL notices are non-critical messages generated by PostgreSQL, either as a result of a user query
  1294. (e.g. as a warning or informational notice), or due to outside activity (e.g. if the database administrator
  1295. initiates a "fast" database shutdown).
  1296. Note that notices are very different from notifications (see the <see cref="E:Npgsql.NpgsqlConnection.Notification"/> event).
  1297. </remarks>
  1298. </member>
  1299. <member name="E:Npgsql.NpgsqlConnection.Notification">
  1300. <summary>
  1301. Fires when PostgreSQL notifications are received from PostgreSQL.
  1302. </summary>
  1303. <remarks>
  1304. PostgreSQL notifications are sent when your connection has registered for notifications on a specific channel via the
  1305. LISTEN command. NOTIFY can be used to generate such notifications, allowing for an inter-connection communication channel.
  1306. Note that notifications are very different from notices (see the <see cref="E:Npgsql.NpgsqlConnection.Notice"/> event).
  1307. </remarks>
  1308. </member>
  1309. <member name="P:Npgsql.NpgsqlConnection.IsSecure">
  1310. <summary>
  1311. Returns whether SSL is being used for the connection.
  1312. </summary>
  1313. </member>
  1314. <member name="P:Npgsql.NpgsqlConnection.ProvideClientCertificatesCallback">
  1315. <summary>
  1316. Selects the local Secure Sockets Layer (SSL) certificate used for authentication.
  1317. </summary>
  1318. <remarks>
  1319. See <see href="https://msdn.microsoft.com/en-us/library/system.net.security.localcertificateselectioncallback(v=vs.110).aspx"/>
  1320. </remarks>
  1321. </member>
  1322. <member name="P:Npgsql.NpgsqlConnection.UserCertificateValidationCallback">
  1323. <summary>
  1324. Verifies the remote Secure Sockets Layer (SSL) certificate used for authentication.
  1325. Ignored if <see cref="P:Npgsql.NpgsqlConnectionStringBuilder.TrustServerCertificate"/> is set.
  1326. </summary>
  1327. <remarks>
  1328. See <see href="https://msdn.microsoft.com/en-us/library/system.net.security.remotecertificatevalidationcallback(v=vs.110).aspx"/>
  1329. </remarks>
  1330. </member>
  1331. <member name="P:Npgsql.NpgsqlConnection.PostgreSqlVersion">
  1332. <summary>
  1333. Version of the PostgreSQL backend.
  1334. This can only be called when there is an active connection.
  1335. </summary>
  1336. </member>
  1337. <member name="P:Npgsql.NpgsqlConnection.ServerVersion">
  1338. <summary>
  1339. PostgreSQL server version.
  1340. </summary>
  1341. </member>
  1342. <member name="P:Npgsql.NpgsqlConnection.ProcessID">
  1343. <summary>
  1344. Process id of backend server.
  1345. This can only be called when there is an active connection.
  1346. </summary>
  1347. </member>
  1348. <member name="P:Npgsql.NpgsqlConnection.HasIntegerDateTimes">
  1349. <summary>
  1350. Reports whether the backend uses the newer integer timestamp representation.
  1351. Note that the old floating point representation is not supported.
  1352. Meant for use by type plugins (e.g. Nodatime)
  1353. </summary>
  1354. </member>
  1355. <member name="P:Npgsql.NpgsqlConnection.Timezone">
  1356. <summary>
  1357. The connection's timezone as reported by PostgreSQL, in the IANA/Olson database format.
  1358. </summary>
  1359. </member>
  1360. <member name="P:Npgsql.NpgsqlConnection.PostgresParameters">
  1361. <summary>
  1362. Holds all PostgreSQL parameters received for this connection. Is updated if the values change
  1363. (e.g. as a result of a SET command).
  1364. </summary>
  1365. </member>
  1366. <member name="M:Npgsql.NpgsqlConnection.BeginBinaryImport(System.String)">
  1367. <summary>
  1368. Begins a binary COPY FROM STDIN operation, a high-performance data import mechanism to a PostgreSQL table.
  1369. </summary>
  1370. <param name="copyFromCommand">A COPY FROM STDIN SQL command</param>
  1371. <returns>A <see cref="T:Npgsql.NpgsqlBinaryImporter"/> which can be used to write rows and columns</returns>
  1372. <remarks>
  1373. See http://www.postgresql.org/docs/current/static/sql-copy.html.
  1374. </remarks>
  1375. </member>
  1376. <member name="M:Npgsql.NpgsqlConnection.BeginBinaryExport(System.String)">
  1377. <summary>
  1378. Begins a binary COPY TO STDOUT operation, a high-performance data export mechanism from a PostgreSQL table.
  1379. </summary>
  1380. <param name="copyToCommand">A COPY TO STDOUT SQL command</param>
  1381. <returns>A <see cref="T:Npgsql.NpgsqlBinaryExporter"/> which can be used to read rows and columns</returns>
  1382. <remarks>
  1383. See http://www.postgresql.org/docs/current/static/sql-copy.html.
  1384. </remarks>
  1385. </member>
  1386. <member name="M:Npgsql.NpgsqlConnection.BeginTextImport(System.String)">
  1387. <summary>
  1388. Begins a textual COPY FROM STDIN operation, a data import mechanism to a PostgreSQL table.
  1389. It is the user's responsibility to send the textual input according to the format specified
  1390. in <paramref name="copyFromCommand"/>.
  1391. </summary>
  1392. <param name="copyFromCommand">A COPY FROM STDIN SQL command</param>
  1393. <returns>
  1394. A TextWriter that can be used to send textual data.</returns>
  1395. <remarks>
  1396. See http://www.postgresql.org/docs/current/static/sql-copy.html.
  1397. </remarks>
  1398. </member>
  1399. <member name="M:Npgsql.NpgsqlConnection.BeginTextExport(System.String)">
  1400. <summary>
  1401. Begins a textual COPY TO STDOUT operation, a data export mechanism from a PostgreSQL table.
  1402. It is the user's responsibility to parse the textual input according to the format specified
  1403. in <paramref name="copyToCommand"/>.
  1404. </summary>
  1405. <param name="copyToCommand">A COPY TO STDOUT SQL command</param>
  1406. <returns>
  1407. A TextReader that can be used to read textual data.</returns>
  1408. <remarks>
  1409. See http://www.postgresql.org/docs/current/static/sql-copy.html.
  1410. </remarks>
  1411. </member>
  1412. <member name="M:Npgsql.NpgsqlConnection.BeginRawBinaryCopy(System.String)">
  1413. <summary>
  1414. Begins a raw binary COPY operation (TO STDOUT or FROM STDIN), a high-performance data export/import mechanism to a PostgreSQL table.
  1415. Note that unlike the other COPY API methods, <see cref="M:Npgsql.NpgsqlConnection.BeginRawBinaryCopy(System.String)"/> doesn't implement any encoding/decoding
  1416. and is unsuitable for structured import/export operation. It is useful mainly for exporting a table as an opaque
  1417. blob, for the purpose of importing it back later.
  1418. </summary>
  1419. <param name="copyCommand">A COPY TO STDOUT or COPY FROM STDIN SQL command</param>
  1420. <returns>A <see cref="T:Npgsql.NpgsqlRawCopyStream"/> that can be used to read or write raw binary data.</returns>
  1421. <remarks>
  1422. See http://www.postgresql.org/docs/current/static/sql-copy.html.
  1423. </remarks>
  1424. </member>
  1425. <member name="M:Npgsql.NpgsqlConnection.MapEnum``1(System.String,Npgsql.INpgsqlNameTranslator)">
  1426. <summary>
  1427. Maps a CLR enum to a PostgreSQL enum type for use with this connection.
  1428. </summary>
  1429. <remarks>
  1430. CLR enum labels are mapped by name to PostgreSQL enum labels.
  1431. The translation strategy can be controlled by the <paramref name="nameTranslator"/> parameter,
  1432. which defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>.
  1433. You can also use the <see cref="T:NpgsqlTypes.PgNameAttribute"/> on your enum fields to manually specify a PostgreSQL enum label.
  1434. If there is a discrepancy between the .NET and database labels while an enum is read or written,
  1435. an exception will be raised.
  1436. Can only be invoked on an open connection; if the connection is closed the mapping is lost.
  1437. To avoid mapping the type for each connection, use the <see cref="M:Npgsql.NpgsqlConnection.MapEnumGlobally``1(System.String,Npgsql.INpgsqlNameTranslator)"/> method.
  1438. </remarks>
  1439. <param name="pgName">
  1440. A PostgreSQL type name for the corresponding enum type in the database.
  1441. If null, the name translator given in <paramref name="nameTranslator"/>will be used.
  1442. </param>
  1443. <param name="nameTranslator">
  1444. A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
  1445. Defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>
  1446. </param>
  1447. <typeparam name="TEnum">The .NET enum type to be mapped</typeparam>
  1448. </member>
  1449. <member name="M:Npgsql.NpgsqlConnection.MapEnumGlobally``1(System.String,Npgsql.INpgsqlNameTranslator)">
  1450. <summary>
  1451. Maps a CLR enum to a PostgreSQL enum type for use with all connections created from now on. Existing connections aren't affected.
  1452. </summary>
  1453. <remarks>
  1454. CLR enum labels are mapped by name to PostgreSQL enum labels.
  1455. The translation strategy can be controlled by the <paramref name="nameTranslator"/> parameter,
  1456. which defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>.
  1457. You can also use the <see cref="T:NpgsqlTypes.PgNameAttribute"/> on your enum fields to manually specify a PostgreSQL enum label.
  1458. If there is a discrepancy between the .NET and database labels while an enum is read or written,
  1459. an exception will be raised.
  1460. To map the type for a specific connection, use the <see cref="M:Npgsql.NpgsqlConnection.MapEnum``1(System.String,Npgsql.INpgsqlNameTranslator)"/> method.
  1461. </remarks>
  1462. <param name="pgName">
  1463. A PostgreSQL type name for the corresponding enum type in the database.
  1464. If null, the name translator given in <paramref name="nameTranslator"/>will be used.
  1465. </param>
  1466. <param name="nameTranslator">
  1467. A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
  1468. Defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>
  1469. </param>
  1470. <typeparam name="TEnum">The .NET enum type to be mapped</typeparam>
  1471. </member>
  1472. <member name="M:Npgsql.NpgsqlConnection.UnmapEnumGlobally``1(System.String,Npgsql.INpgsqlNameTranslator)">
  1473. <summary>
  1474. Removes a previous global enum mapping.
  1475. </summary>
  1476. <param name="pgName">
  1477. A PostgreSQL type name for the corresponding enum type in the database.
  1478. If null, the name translator given in <paramref name="nameTranslator"/>will be used.
  1479. </param>
  1480. <param name="nameTranslator">
  1481. A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
  1482. Defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>
  1483. </param>
  1484. </member>
  1485. <member name="M:Npgsql.NpgsqlConnection.MapComposite``1(System.String,Npgsql.INpgsqlNameTranslator)">
  1486. <summary>
  1487. Maps a CLR type to a PostgreSQL composite type for use with this connection.
  1488. </summary>
  1489. <remarks>
  1490. CLR fields and properties by string to PostgreSQL enum labels.
  1491. The translation strategy can be controlled by the <paramref name="nameTranslator"/> parameter,
  1492. which defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>.
  1493. You can also use the <see cref="T:NpgsqlTypes.PgNameAttribute"/> on your members to manually specify a PostgreSQL enum label.
  1494. If there is a discrepancy between the .NET and database labels while a composite is read or written,
  1495. an exception will be raised.
  1496. Can only be invoked on an open connection; if the connection is closed the mapping is lost.
  1497. To avoid mapping the type for each connection, use the <see cref="M:Npgsql.NpgsqlConnection.MapCompositeGlobally``1(System.String,Npgsql.INpgsqlNameTranslator)"/> method.
  1498. </remarks>
  1499. <param name="pgName">
  1500. A PostgreSQL type name for the corresponding enum type in the database.
  1501. If null, the name translator given in <paramref name="nameTranslator"/>will be used.
  1502. </param>
  1503. <param name="nameTranslator">
  1504. A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
  1505. Defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>
  1506. </param>
  1507. <typeparam name="T">The .NET type to be mapped</typeparam>
  1508. </member>
  1509. <member name="M:Npgsql.NpgsqlConnection.MapCompositeGlobally``1(System.String,Npgsql.INpgsqlNameTranslator)">
  1510. <summary>
  1511. Maps a CLR type to a PostgreSQL composite type for use with all connections created from now on. Existing connections aren't affected.
  1512. </summary>
  1513. <remarks>
  1514. CLR fields and properties by string to PostgreSQL enum labels.
  1515. The translation strategy can be controlled by the <paramref name="nameTranslator"/> parameter,
  1516. which defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>.
  1517. You can also use the <see cref="T:NpgsqlTypes.PgNameAttribute"/> on your members to manually specify a PostgreSQL enum label.
  1518. If there is a discrepancy between the .NET and database labels while a composite is read or written,
  1519. an exception will be raised.
  1520. To map the type for a specific connection, use the <see cref="M:Npgsql.NpgsqlConnection.MapEnum``1(System.String,Npgsql.INpgsqlNameTranslator)"/> method.
  1521. </remarks>
  1522. <param name="pgName">
  1523. A PostgreSQL type name for the corresponding enum type in the database.
  1524. If null, the name translator given in <paramref name="nameTranslator"/>will be used.
  1525. </param>
  1526. <param name="nameTranslator">
  1527. A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
  1528. Defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>
  1529. </param>
  1530. <typeparam name="T">The .NET type to be mapped</typeparam>
  1531. </member>
  1532. <member name="M:Npgsql.NpgsqlConnection.UnmapCompositeGlobally``1(System.String,Npgsql.INpgsqlNameTranslator)">
  1533. <summary>
  1534. Removes a previous global enum mapping.
  1535. </summary>
  1536. <param name="pgName">
  1537. A PostgreSQL type name for the corresponding enum type in the database.
  1538. If null, the name translator given in <paramref name="nameTranslator"/>will be used.
  1539. </param>
  1540. <param name="nameTranslator">
  1541. A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
  1542. Defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>
  1543. </param>
  1544. </member>
  1545. <member name="M:Npgsql.NpgsqlConnection.Wait(System.Int32)">
  1546. <summary>
  1547. Waits until an asynchronous PostgreSQL messages (e.g. a notification) arrives, and
  1548. exits immediately. The asynchronous message is delivered via the normal events
  1549. (<see cref="E:Npgsql.NpgsqlConnection.Notification"/>, <see cref="E:Npgsql.NpgsqlConnection.Notice"/>).
  1550. </summary>
  1551. <param name="timeout">
  1552. The time-out value, in milliseconds, passed to <see cref="P:System.Net.Sockets.Socket.ReceiveTimeout"/>.
  1553. The default value is 0, which indicates an infinite time-out period.
  1554. Specifying -1 also indicates an infinite time-out period.
  1555. </param>
  1556. <returns>true if an asynchronous message was received, false if timed out.</returns>
  1557. </member>
  1558. <member name="M:Npgsql.NpgsqlConnection.Wait(System.TimeSpan)">
  1559. <summary>
  1560. Waits until an asynchronous PostgreSQL messages (e.g. a notification) arrives, and
  1561. exits immediately. The asynchronous message is delivered via the normal events
  1562. (<see cref="E:Npgsql.NpgsqlConnection.Notification"/>, <see cref="E:Npgsql.NpgsqlConnection.Notice"/>).
  1563. </summary>
  1564. <param name="timeout">
  1565. The time-out value is passed to <see cref="P:System.Net.Sockets.Socket.ReceiveTimeout"/>.
  1566. </param>
  1567. <returns>true if an asynchronous message was received, false if timed out.</returns>
  1568. </member>
  1569. <member name="M:Npgsql.NpgsqlConnection.Wait">
  1570. <summary>
  1571. Waits until an asynchronous PostgreSQL messages (e.g. a notification) arrives, and
  1572. exits immediately. The asynchronous message is delivered via the normal events
  1573. (<see cref="E:Npgsql.NpgsqlConnection.Notification"/>, <see cref="E:Npgsql.NpgsqlConnection.Notice"/>).
  1574. </summary>
  1575. </member>
  1576. <member name="M:Npgsql.NpgsqlConnection.WaitAsync(System.Threading.CancellationToken)">
  1577. <summary>
  1578. Waits asynchronously until an asynchronous PostgreSQL messages (e.g. a notification)
  1579. arrives, and exits immediately. The asynchronous message is delivered via the normal events
  1580. (<see cref="E:Npgsql.NpgsqlConnection.Notification"/>, <see cref="E:Npgsql.NpgsqlConnection.Notice"/>).
  1581. CancelationToken can not cancel wait operation if underlying NetworkStream does not support it
  1582. (see https://stackoverflow.com/questions/12421989/networkstream-readasync-with-a-cancellation-token-never-cancels ).
  1583. </summary>
  1584. </member>
  1585. <member name="M:Npgsql.NpgsqlConnection.WaitAsync">
  1586. <summary>
  1587. Waits asynchronously until an asynchronous PostgreSQL messages (e.g. a notification)
  1588. arrives, and exits immediately. The asynchronous message is delivered via the normal events
  1589. (<see cref="E:Npgsql.NpgsqlConnection.Notification"/>, <see cref="E:Npgsql.NpgsqlConnection.Notice"/>).
  1590. </summary>
  1591. </member>
  1592. <member name="M:Npgsql.NpgsqlConnection.GetSchema">
  1593. <summary>
  1594. Returns the supported collections
  1595. </summary>
  1596. </member>
  1597. <member name="M:Npgsql.NpgsqlConnection.GetSchema(System.String)">
  1598. <summary>
  1599. Returns the schema collection specified by the collection name.
  1600. </summary>
  1601. <param name="collectionName">The collection name.</param>
  1602. <returns>The collection specified.</returns>
  1603. </member>
  1604. <member name="M:Npgsql.NpgsqlConnection.GetSchema(System.String,System.String[])">
  1605. <summary>
  1606. Returns the schema collection specified by the collection name filtered by the restrictions.
  1607. </summary>
  1608. <param name="collectionName">The collection name.</param>
  1609. <param name="restrictions">
  1610. The restriction values to filter the results. A description of the restrictions is contained
  1611. in the Restrictions collection.
  1612. </param>
  1613. <returns>The collection specified.</returns>
  1614. </member>
  1615. <member name="M:Npgsql.NpgsqlConnection.System#ICloneable#Clone">
  1616. <summary>
  1617. Creates a closed connection with the connection string and authentication details of this message.
  1618. </summary>
  1619. </member>
  1620. <member name="M:Npgsql.NpgsqlConnection.CloneWith(System.String)">
  1621. <summary>
  1622. Clones this connection, replacing its connection string with the given one.
  1623. This allows creating a new connection with the same security information
  1624. (password, SSL callbacks) while changing other connection parameters (e.g.
  1625. database or pooling)
  1626. </summary>
  1627. </member>
  1628. <member name="M:Npgsql.NpgsqlConnection.ChangeDatabase(System.String)">
  1629. <summary>
  1630. This method changes the current database by disconnecting from the actual
  1631. database and connecting to the specified.
  1632. </summary>
  1633. <param name="dbName">The name of the database to use in place of the current database.</param>
  1634. </member>
  1635. <member name="P:Npgsql.NpgsqlConnection.DbProviderFactory">
  1636. <summary>
  1637. DB provider factory.
  1638. </summary>
  1639. </member>
  1640. <member name="M:Npgsql.NpgsqlConnection.ClearPool(Npgsql.NpgsqlConnection)">
  1641. <summary>
  1642. Clear connection pool.
  1643. </summary>
  1644. </member>
  1645. <member name="M:Npgsql.NpgsqlConnection.ClearAllPools">
  1646. <summary>
  1647. Clear all connection pools.
  1648. </summary>
  1649. </member>
  1650. <member name="M:Npgsql.NpgsqlConnection.UnprepareAll">
  1651. <summary>
  1652. Unprepares all prepared statements on this connection.
  1653. </summary>
  1654. </member>
  1655. <member name="M:Npgsql.NpgsqlConnection.ReloadTypes">
  1656. <summary>
  1657. Flushes the type cache for this connection's connection string and reloads the types for this connection only.
  1658. Type changes will appear for other connections only after they are re-opened from the pool.
  1659. </summary>
  1660. </member>
  1661. <member name="T:Npgsql.NoticeEventHandler">
  1662. <summary>
  1663. Represents a method that handles the <see cref="E:Npgsql.NpgsqlConnection.Notice"/> event.
  1664. </summary>
  1665. <param name="sender">The source of the event.</param>
  1666. <param name="e">A <see cref="T:Npgsql.NpgsqlNoticeEventArgs"/> that contains the notice information (e.g. message, severity...).</param>
  1667. </member>
  1668. <member name="T:Npgsql.NotificationEventHandler">
  1669. <summary>
  1670. Represents a method that handles the <see cref="E:Npgsql.NpgsqlConnection.Notification"/> event.
  1671. </summary>
  1672. <param name="sender">The source of the event.</param>
  1673. <param name="e">A <see cref="T:Npgsql.NpgsqlNotificationEventArgs"/> that contains the notification payload.</param>
  1674. </member>
  1675. <member name="T:Npgsql.ProvideClientCertificatesCallback">
  1676. <summary>
  1677. Represents the method that allows the application to provide a certificate collection to be used for SSL client authentication
  1678. </summary>
  1679. <param name="certificates">A <see cref="T:System.Security.Cryptography.X509Certificates.X509CertificateCollection">X509CertificateCollection</see> to be filled with one or more client certificates.</param>
  1680. </member>
  1681. <member name="T:Npgsql.NpgsqlConnectionStringBuilder">
  1682. <summary>
  1683. Provides a simple way to create and manage the contents of connection strings used by
  1684. the <see cref="T:Npgsql.NpgsqlConnection"/> class.
  1685. </summary>
  1686. </member>
  1687. <member name="F:Npgsql.NpgsqlConnectionStringBuilder.PropertiesByKeyword">
  1688. <summary>
  1689. Makes all valid keywords for a property to that property (e.g. User Name -> Username, UserId -> Username...)
  1690. </summary>
  1691. </member>
  1692. <member name="F:Npgsql.NpgsqlConnectionStringBuilder.PropertyNameToCanonicalKeyword">
  1693. <summary>
  1694. Maps CLR property names (e.g. BufferSize) to their canonical keyword name, which is the
  1695. property's [DisplayName] (e.g. Buffer Size)
  1696. </summary>
  1697. </member>
  1698. <member name="F:Npgsql.NpgsqlConnectionStringBuilder.PropertyDefaults">
  1699. <summary>
  1700. Maps each property to its [DefaultValue]
  1701. </summary>
  1702. </member>
  1703. <member name="M:Npgsql.NpgsqlConnectionStringBuilder.#ctor">
  1704. <summary>
  1705. Initializes a new instance of the NpgsqlConnectionStringBuilder class.
  1706. </summary>
  1707. </member>
  1708. <member name="M:Npgsql.NpgsqlConnectionStringBuilder.#ctor(System.Boolean)">
  1709. <summary>
  1710. Initializes a new instance of the NpgsqlConnectionStringBuilder class, optionally using ODBC rules for quoting values.
  1711. </summary>
  1712. <param name="useOdbcRules">true to use {} to delimit fields; false to use quotation marks.</param>
  1713. </member>
  1714. <member name="M:Npgsql.NpgsqlConnectionStringBuilder.#ctor(System.String)">
  1715. <summary>
  1716. Initializes a new instance of the NpgsqlConnectionStringBuilder class and sets its <see cref="P:System.Data.Common.DbConnectionStringBuilder.ConnectionString"/>.
  1717. </summary>
  1718. </member>
  1719. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Item(System.String)">
  1720. <summary>
  1721. Gets or sets the value associated with the specified key.
  1722. </summary>
  1723. <param name="keyword">The key of the item to get or set.</param>
  1724. <returns>The value associated with the specified key.</returns>
  1725. </member>
  1726. <member name="M:Npgsql.NpgsqlConnectionStringBuilder.Add(System.Collections.Generic.KeyValuePair{System.String,System.Object})">
  1727. <summary>
  1728. Adds an item to the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/>.
  1729. </summary>
  1730. <param name="item">The key-value pair to be added.</param>
  1731. </member>
  1732. <member name="M:Npgsql.NpgsqlConnectionStringBuilder.Remove(System.String)">
  1733. <summary>
  1734. Removes the entry with the specified key from the DbConnectionStringBuilder instance.
  1735. </summary>
  1736. <param name="keyword">The key of the key/value pair to be removed from the connection string in this DbConnectionStringBuilder.</param>
  1737. <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>
  1738. </member>
  1739. <member name="M:Npgsql.NpgsqlConnectionStringBuilder.Remove(System.Collections.Generic.KeyValuePair{System.String,System.Object})">
  1740. <summary>
  1741. Removes the entry from the DbConnectionStringBuilder instance.
  1742. </summary>
  1743. <param name="item">The key/value pair to be removed from the connection string in this DbConnectionStringBuilder.</param>
  1744. <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>
  1745. </member>
  1746. <member name="M:Npgsql.NpgsqlConnectionStringBuilder.Clear">
  1747. <summary>
  1748. Clears the contents of the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/> instance.
  1749. </summary>
  1750. </member>
  1751. <member name="M:Npgsql.NpgsqlConnectionStringBuilder.ContainsKey(System.String)">
  1752. <summary>
  1753. Determines whether the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/> contains a specific key.
  1754. </summary>
  1755. <param name="keyword">The key to locate in the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/>.</param>
  1756. <returns><b>true</b> if the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/> contains an entry with the specified key; otherwise <b>false</b>.</returns>
  1757. </member>
  1758. <member name="M:Npgsql.NpgsqlConnectionStringBuilder.Contains(System.Collections.Generic.KeyValuePair{System.String,System.Object})">
  1759. <summary>
  1760. Determines whether the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/> contains a specific key-value pair.
  1761. </summary>
  1762. <param name="item">The itemto locate in the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/>.</param>
  1763. <returns><b>true</b> if the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/> contains the entry; otherwise <b>false</b>.</returns>
  1764. </member>
  1765. <member name="M:Npgsql.NpgsqlConnectionStringBuilder.TryGetValue(System.String,System.Object@)">
  1766. <summary>
  1767. Retrieves a value corresponding to the supplied key from this <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/>.
  1768. </summary>
  1769. <param name="keyword">The key of the item to retrieve.</param>
  1770. <param name="value">The value corresponding to the key.</param>
  1771. <returns><b>true</b> if keyword was found within the connection string, <b>false</b> otherwise.</returns>
  1772. </member>
  1773. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Host">
  1774. <summary>
  1775. The hostname or IP address of the PostgreSQL server to connect to.
  1776. </summary>
  1777. </member>
  1778. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Port">
  1779. <summary>
  1780. The TCP/IP port of the PostgreSQL server.
  1781. </summary>
  1782. </member>
  1783. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Database">
  1784. <summary>
  1785. The PostgreSQL database to connect to.
  1786. </summary>
  1787. </member>
  1788. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Username">
  1789. <summary>
  1790. The username to connect with. Not required if using IntegratedSecurity.
  1791. </summary>
  1792. </member>
  1793. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Password">
  1794. <summary>
  1795. The password to connect with. Not required if using IntegratedSecurity.
  1796. </summary>
  1797. </member>
  1798. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Passfile">
  1799. <summary>
  1800. Path to a PostgreSQL password file (PGPASSFILE), from which the password would be taken.
  1801. </summary>
  1802. </member>
  1803. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ApplicationName">
  1804. <summary>
  1805. The optional application name parameter to be sent to the backend during connection initiation.
  1806. </summary>
  1807. </member>
  1808. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Enlist">
  1809. <summary>
  1810. Whether to enlist in an ambient TransactionScope.
  1811. </summary>
  1812. </member>
  1813. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.SearchPath">
  1814. <summary>
  1815. Gets or sets the schema search path.
  1816. </summary>
  1817. </member>
  1818. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ClientEncoding">
  1819. <summary>
  1820. Gets or sets the client_encoding parameter.
  1821. </summary>
  1822. </member>
  1823. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Encoding">
  1824. <summary>
  1825. Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data.
  1826. </summary>
  1827. </member>
  1828. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Timezone">
  1829. <summary>
  1830. Gets or sets the PostgreSQL session timezone, in Olson/IANA database format.
  1831. </summary>
  1832. </member>
  1833. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.SslMode">
  1834. <summary>
  1835. Controls whether SSL is required, disabled or preferred, depending on server support.
  1836. </summary>
  1837. </member>
  1838. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.TrustServerCertificate">
  1839. <summary>
  1840. Whether to trust the server certificate without validating it.
  1841. </summary>
  1842. </member>
  1843. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.CheckCertificateRevocation">
  1844. <summary>
  1845. Whether to check the certificate revocation list during authentication.
  1846. False by default.
  1847. </summary>
  1848. </member>
  1849. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.UseSslStream">
  1850. <summary>
  1851. Npgsql uses its own internal implementation of TLS/SSL. Turn this on to use .NET SslStream instead.
  1852. </summary>
  1853. </member>
  1854. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.IntegratedSecurity">
  1855. <summary>
  1856. Whether to use Windows integrated security to log in.
  1857. </summary>
  1858. </member>
  1859. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.KerberosServiceName">
  1860. <summary>
  1861. The Kerberos service name to be used for authentication.
  1862. </summary>
  1863. </member>
  1864. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.IncludeRealm">
  1865. <summary>
  1866. The Kerberos realm to be used for authentication.
  1867. </summary>
  1868. </member>
  1869. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.PersistSecurityInfo">
  1870. <summary>
  1871. 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.
  1872. </summary>
  1873. </member>
  1874. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.LogParameters">
  1875. <summary>
  1876. When enabled, parameter values are logged when commands are executed. Defaults to false.
  1877. </summary>
  1878. </member>
  1879. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.IncludeErrorDetails">
  1880. <summary>
  1881. When enabled, PostgreSQL error details are included on <see cref="P:Npgsql.PostgresException.Detail" /> and
  1882. <see cref="P:Npgsql.PostgresNotice.Detail" />. These can contain sensitive data.
  1883. </summary>
  1884. </member>
  1885. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Pooling">
  1886. <summary>
  1887. Whether connection pooling should be used.
  1888. </summary>
  1889. </member>
  1890. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.MinPoolSize">
  1891. <summary>
  1892. The minimum connection pool size.
  1893. </summary>
  1894. </member>
  1895. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.MaxPoolSize">
  1896. <summary>
  1897. The maximum connection pool size.
  1898. </summary>
  1899. </member>
  1900. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ConnectionIdleLifetime">
  1901. <summary>
  1902. The time to wait before closing idle connections in the pool if the count
  1903. of all connections exceeds MinPoolSize.
  1904. </summary>
  1905. <value>The time (in seconds) to wait. The default value is 300.</value>
  1906. </member>
  1907. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ConnectionPruningInterval">
  1908. <summary>
  1909. How many seconds the pool waits before attempting to prune idle connections that are beyond
  1910. idle lifetime (<see cref="P:Npgsql.NpgsqlConnectionStringBuilder.ConnectionIdleLifetime"/>.
  1911. </summary>
  1912. <value>The interval (in seconds). The default value is 10.</value>
  1913. </member>
  1914. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Timeout">
  1915. <summary>
  1916. The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error.
  1917. Defaults to 15 seconds.
  1918. </summary>
  1919. </member>
  1920. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.CommandTimeout">
  1921. <summary>
  1922. The time to wait (in seconds) while trying to execute a command before terminating the attempt and generating an error.
  1923. Defaults to 30 seconds.
  1924. </summary>
  1925. </member>
  1926. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.InternalCommandTimeout">
  1927. <summary>
  1928. The time to wait (in seconds) while trying to execute a an internal command before terminating the attempt and generating an error.
  1929. </summary>
  1930. </member>
  1931. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.EntityTemplateDatabase">
  1932. <summary>
  1933. The database template to specify when creating a database in Entity Framework. If not specified,
  1934. PostgreSQL defaults to "template1".
  1935. </summary>
  1936. <remarks>
  1937. http://www.postgresql.org/docs/current/static/manage-ag-templatedbs.html
  1938. </remarks>
  1939. </member>
  1940. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.EntityAdminDatabase">
  1941. <summary>
  1942. The database admin to specify when creating and dropping a database in Entity Framework. This is needed because
  1943. Npgsql needs to connect to a database in order to send the create/drop database command.
  1944. If not specified, defaults to "template1". Check NpgsqlServices.UsingPostgresDBConnection for more information.
  1945. </summary>
  1946. </member>
  1947. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.KeepAlive">
  1948. <summary>
  1949. The number of seconds of connection inactivity before Npgsql sends a keepalive query.
  1950. Set to 0 (the default) to disable.
  1951. </summary>
  1952. </member>
  1953. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.TcpKeepAlive">
  1954. <summary>
  1955. Whether to use TCP keepalive with system defaults if overrides isn't specified.
  1956. </summary>
  1957. </member>
  1958. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.TcpKeepAliveTime">
  1959. <summary>
  1960. The number of seconds of connection inactivity before a TCP keepalive query is sent.
  1961. Use of this option is discouraged, use <see cref="P:Npgsql.NpgsqlConnectionStringBuilder.KeepAlive"/> instead if possible.
  1962. Set to 0 (the default) to disable. Supported only on Windows.
  1963. </summary>
  1964. </member>
  1965. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.TcpKeepAliveInterval">
  1966. <summary>
  1967. The interval, in milliseconds, between when successive keep-alive packets are sent if no acknowledgement is received.
  1968. Defaults to the value of <see cref="P:Npgsql.NpgsqlConnectionStringBuilder.TcpKeepAliveTime"/>. <see cref="P:Npgsql.NpgsqlConnectionStringBuilder.TcpKeepAliveTime"/> must be non-zero as well.
  1969. Supported only on Windows.
  1970. </summary>
  1971. </member>
  1972. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ReadBufferSize">
  1973. <summary>
  1974. Determines the size of the internal buffer Npgsql uses when reading. Increasing may improve performance if transferring large values from the database.
  1975. </summary>
  1976. </member>
  1977. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.WriteBufferSize">
  1978. <summary>
  1979. Determines the size of the internal buffer Npgsql uses when writing. Increasing may improve performance if transferring large values to the database.
  1980. </summary>
  1981. </member>
  1982. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.SocketReceiveBufferSize">
  1983. <summary>
  1984. Determines the size of socket read buffer.
  1985. </summary>
  1986. </member>
  1987. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.SocketSendBufferSize">
  1988. <summary>
  1989. Determines the size of socket send buffer.
  1990. </summary>
  1991. </member>
  1992. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.MaxAutoPrepare">
  1993. <summary>
  1994. The maximum number SQL statements that can be automatically prepared at any given point.
  1995. Beyond this number the least-recently-used statement will be recycled.
  1996. Zero (the default) disables automatic preparation.
  1997. </summary>
  1998. </member>
  1999. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.AutoPrepareMinUsages">
  2000. <summary>
  2001. The minimum number of usages an SQL statement is used before it's automatically prepared.
  2002. Defaults to 5.
  2003. </summary>
  2004. </member>
  2005. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.UsePerfCounters">
  2006. <summary>
  2007. Writes connection performance information to performance counters.
  2008. </summary>
  2009. </member>
  2010. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.NoResetOnClose">
  2011. <summary>
  2012. If set to true, a pool connection's state won't be reset when it is closed (improves performance).
  2013. Do not specify this unless you know what you're doing.
  2014. </summary>
  2015. </member>
  2016. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.LoadTableComposites">
  2017. <summary>
  2018. Load table composite type definitions, and not just free-standing composite types.
  2019. </summary>
  2020. </member>
  2021. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ServerCompatibilityMode">
  2022. <summary>
  2023. A compatibility mode for special PostgreSQL server types.
  2024. </summary>
  2025. </member>
  2026. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ConvertInfinityDateTime">
  2027. <summary>
  2028. Makes MaxValue and MinValue timestamps and dates readable as infinity and negative infinity.
  2029. </summary>
  2030. </member>
  2031. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ConnectionLifeTime">
  2032. <summary>
  2033. Obsolete, see http://www.npgsql.org/doc/migration/3.1.html
  2034. </summary>
  2035. </member>
  2036. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.ContinuousProcessing">
  2037. <summary>
  2038. Obsolete, see http://www.npgsql.org/doc/migration/3.1.html
  2039. </summary>
  2040. </member>
  2041. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.BackendTimeouts">
  2042. <summary>
  2043. Obsolete, see http://www.npgsql.org/doc/migration/3.1.html
  2044. </summary>
  2045. </member>
  2046. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.PreloadReader">
  2047. <summary>
  2048. Obsolete, see http://www.npgsql.org/doc/migration/3.0.html
  2049. </summary>
  2050. </member>
  2051. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.UseExtendedTypes">
  2052. <summary>
  2053. Obsolete, see http://www.npgsql.org/doc/migration/3.0.html
  2054. </summary>
  2055. </member>
  2056. <member name="M:Npgsql.NpgsqlConnectionStringBuilder.Equals(System.Object)">
  2057. <summary>
  2058. Determines whether the specified object is equal to the current object.
  2059. </summary>
  2060. </member>
  2061. <member name="M:Npgsql.NpgsqlConnectionStringBuilder.GetHashCode">
  2062. <summary>
  2063. Hash function.
  2064. </summary>
  2065. <returns></returns>
  2066. </member>
  2067. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Keys">
  2068. <summary>
  2069. Gets an ICollection{string} containing the keys of the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/>.
  2070. </summary>
  2071. </member>
  2072. <member name="P:Npgsql.NpgsqlConnectionStringBuilder.Values">
  2073. <summary>
  2074. Gets an ICollection{string} containing the values in the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/>.
  2075. </summary>
  2076. </member>
  2077. <member name="M:Npgsql.NpgsqlConnectionStringBuilder.CopyTo(System.Collections.Generic.KeyValuePair{System.String,System.Object}[],System.Int32)">
  2078. <summary>
  2079. Copies the elements of the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/> to an Array, starting at a particular Array index.
  2080. </summary>
  2081. <param name="array">
  2082. The one-dimensional Array that is the destination of the elements copied from <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/>.
  2083. The Array must have zero-based indexing.
  2084. </param>
  2085. <param name="arrayIndex">
  2086. The zero-based index in array at which copying begins.
  2087. </param>
  2088. </member>
  2089. <member name="M:Npgsql.NpgsqlConnectionStringBuilder.GetEnumerator">
  2090. <summary>
  2091. Returns an enumerator that iterates through the <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/>.
  2092. </summary>
  2093. <returns></returns>
  2094. </member>
  2095. <member name="T:Npgsql.NpgsqlConnectionStringPropertyAttribute">
  2096. <summary>
  2097. Marks on <see cref="T:Npgsql.NpgsqlConnectionStringBuilder"/> which participate in the connection
  2098. string. Optionally holds a set of synonyms for the property.
  2099. </summary>
  2100. </member>
  2101. <member name="P:Npgsql.NpgsqlConnectionStringPropertyAttribute.Synonyms">
  2102. <summary>
  2103. Holds a list of synonyms for the property.
  2104. </summary>
  2105. </member>
  2106. <member name="M:Npgsql.NpgsqlConnectionStringPropertyAttribute.#ctor">
  2107. <summary>
  2108. Creates a <see cref="T:Npgsql.NpgsqlConnectionStringPropertyAttribute"/>.
  2109. </summary>
  2110. </member>
  2111. <member name="M:Npgsql.NpgsqlConnectionStringPropertyAttribute.#ctor(System.String[])">
  2112. <summary>
  2113. Creates a <see cref="T:Npgsql.NpgsqlConnectionStringPropertyAttribute"/>.
  2114. </summary>
  2115. </member>
  2116. <member name="T:Npgsql.ServerCompatibilityMode">
  2117. <summary>
  2118. An option specified in the connection string that activates special compatibility features.
  2119. </summary>
  2120. </member>
  2121. <member name="F:Npgsql.ServerCompatibilityMode.None">
  2122. <summary>
  2123. No special server compatibility mode is active
  2124. </summary>
  2125. </member>
  2126. <member name="F:Npgsql.ServerCompatibilityMode.Redshift">
  2127. <summary>
  2128. The server is an Amazon Redshift instance.
  2129. </summary>
  2130. </member>
  2131. <member name="F:Npgsql.ServerCompatibilityMode.NoTypeLoading">
  2132. <summary>
  2133. The server is doesn't support full type loading from the PostgreSQL catalogs, support the basic set
  2134. of types via information hardcoded inside Npgsql.
  2135. </summary>
  2136. </member>
  2137. <member name="T:Npgsql.SslMode">
  2138. <summary>
  2139. Specifies how to manage SSL.
  2140. </summary>
  2141. </member>
  2142. <member name="F:Npgsql.SslMode.Disable">
  2143. <summary>
  2144. SSL is disabled. If the server requires SSL, the connection will fail.
  2145. </summary>
  2146. </member>
  2147. <member name="F:Npgsql.SslMode.Prefer">
  2148. <summary>
  2149. Prefer SSL connections if the server allows them, but allow connections without SSL.
  2150. </summary>
  2151. </member>
  2152. <member name="F:Npgsql.SslMode.Require">
  2153. <summary>
  2154. Fail the connection if the server doesn't suppotr SSL.
  2155. </summary>
  2156. </member>
  2157. <member name="T:Npgsql.NpgsqlConnector">
  2158. <summary>
  2159. Represents a connection to a PostgreSQL backend. Unlike NpgsqlConnection objects, which are
  2160. exposed to users, connectors are internal to Npgsql and are recycled by the connection pool.
  2161. </summary>
  2162. </member>
  2163. <member name="T:Npgsql.NpgsqlConnector.GSSPasswordMessageStream">
  2164. <summary>
  2165. This Stream is placed between NegotiateStream and the socket's NetworkStream (or SSLStream). It intercepts
  2166. traffic and performs the following operations:
  2167. * Outgoing messages are framed in PostgreSQL's PasswordMessage, and incoming are stripped of it.
  2168. * NegotiateStream frames payloads with a 5-byte header, which PostgreSQL doesn't understand. This header is
  2169. stripped from outgoing messages and added to incoming ones.
  2170. </summary>
  2171. <remarks>
  2172. See https://referencesource.microsoft.com/#System/net/System/Net/_StreamFramer.cs,16417e735f0e9530,references
  2173. </remarks>
  2174. </member>
  2175. <member name="F:Npgsql.NpgsqlConnector._socket">
  2176. <summary>
  2177. The physical connection socket to the backend.
  2178. </summary>
  2179. </member>
  2180. <member name="F:Npgsql.NpgsqlConnector._baseStream">
  2181. <summary>
  2182. The physical connection stream to the backend, without anything on top.
  2183. </summary>
  2184. </member>
  2185. <member name="F:Npgsql.NpgsqlConnector._stream">
  2186. <summary>
  2187. The physical connection stream to the backend, layered with an SSL/TLS stream if in secure mode.
  2188. </summary>
  2189. </member>
  2190. <member name="P:Npgsql.NpgsqlConnector.ReadBuffer">
  2191. <summary>
  2192. Buffer used for reading data.
  2193. </summary>
  2194. </member>
  2195. <member name="F:Npgsql.NpgsqlConnector._origReadBuffer">
  2196. <summary>
  2197. If we read a data row that's bigger than <see cref="P:Npgsql.NpgsqlConnector.ReadBuffer"/>, we allocate an oversize buffer.
  2198. The original (smaller) buffer is stored here, and restored when the connection is reset.
  2199. </summary>
  2200. </member>
  2201. <member name="P:Npgsql.NpgsqlConnector.WriteBuffer">
  2202. <summary>
  2203. Buffer used for writing data.
  2204. </summary>
  2205. </member>
  2206. <member name="F:Npgsql.NpgsqlConnector._backendSecretKey">
  2207. <summary>
  2208. The secret key of the backend for this connector, used for query cancellation.
  2209. </summary>
  2210. </member>
  2211. <member name="P:Npgsql.NpgsqlConnector.BackendProcessId">
  2212. <summary>
  2213. The process ID of the backend for this connector.
  2214. </summary>
  2215. </member>
  2216. <member name="P:Npgsql.NpgsqlConnector.Id">
  2217. <summary>
  2218. A unique ID identifying this connector, used for logging. Currently mapped to BackendProcessId
  2219. </summary>
  2220. </member>
  2221. <member name="P:Npgsql.NpgsqlConnector.TransactionStatus">
  2222. <summary>
  2223. The current transaction status for this connector.
  2224. </summary>
  2225. </member>
  2226. <member name="P:Npgsql.NpgsqlConnector.Transaction">
  2227. <summary>
  2228. The transaction currently in progress, if any.
  2229. </summary>
  2230. <remarks>
  2231. <para>
  2232. Note that this doesn't mean a transaction request has actually been sent to the backend - for
  2233. efficiency we defer sending the request to the first query after BeginTransaction is called.
  2234. See <see cref="P:Npgsql.NpgsqlConnector.TransactionStatus"/> for the actual transaction status.
  2235. </para>
  2236. <para>
  2237. Also, the user can initiate a transaction in SQL (i.e. BEGIN), in which case there will be no
  2238. NpgsqlTransaction instance. As a result, never check <see cref="P:Npgsql.NpgsqlConnector.Transaction"/> to know whether
  2239. a transaction is in progress, check <see cref="P:Npgsql.NpgsqlConnector.TransactionStatus"/> instead.
  2240. </para>
  2241. </remarks>
  2242. </member>
  2243. <member name="P:Npgsql.NpgsqlConnector.Connection">
  2244. <summary>
  2245. The NpgsqlConnection that (currently) owns this connector. Null if the connector isn't
  2246. owned (i.e. idle in the pool)
  2247. </summary>
  2248. </member>
  2249. <member name="F:Npgsql.NpgsqlConnector._pendingPrependedResponses">
  2250. <summary>
  2251. The number of messages that were prepended to the current message chain, but not yet sent.
  2252. Note that this only tracks messages which produce a ReadyForQuery message
  2253. </summary>
  2254. </member>
  2255. <member name="F:Npgsql.NpgsqlConnector.CurrentCopyOperation">
  2256. <summary>
  2257. If the connector is currently in COPY mode, holds a reference to the importer/exporter object.
  2258. Otherwise null.
  2259. </summary>
  2260. </member>
  2261. <member name="F:Npgsql.NpgsqlConnector.PostgresParameters">
  2262. <summary>
  2263. Holds all run-time parameters received from the backend (via ParameterStatus messages)
  2264. </summary>
  2265. </member>
  2266. <member name="P:Npgsql.NpgsqlConnector.UserTimeout">
  2267. <summary>
  2268. The timeout for reading messages that are part of the user's command
  2269. (i.e. which aren't internal prepended commands).
  2270. </summary>
  2271. </member>
  2272. <member name="F:Npgsql.NpgsqlConnector._currentTimeout">
  2273. <summary>
  2274. Contains the current value of the socket's ReceiveTimeout, used to determine whether
  2275. we need to change it when commands are received.
  2276. </summary>
  2277. </member>
  2278. <member name="F:Npgsql.NpgsqlConnector._userLock">
  2279. <summary>
  2280. A lock that's taken while a user action is in progress, e.g. a command being executed.
  2281. Only used when keepalive is enabled, otherwise null.
  2282. </summary>
  2283. </member>
  2284. <member name="P:Npgsql.NpgsqlConnector.CancelLock">
  2285. <summary>
  2286. A lock that's taken while a cancellation is being delivered; new queries are blocked until the
  2287. cancellation is delivered. This reduces the chance that a cancellation meant for a previous
  2288. command will accidentally cancel a later one, see #615.
  2289. </summary>
  2290. </member>
  2291. <member name="F:Npgsql.NpgsqlConnector._currentCommand">
  2292. <summary>
  2293. The command currently being executed by the connector, null otherwise.
  2294. Used only for concurrent use error reporting purposes.
  2295. </summary>
  2296. </member>
  2297. <member name="P:Npgsql.NpgsqlConnector.ReleaseTimestamp">
  2298. <summary>
  2299. If pooled, the timestamp when this connector was returned to the pool.
  2300. </summary>
  2301. </member>
  2302. <member name="F:Npgsql.NpgsqlConnector.MinimumInternalCommandTimeout">
  2303. <summary>
  2304. The minimum timeout that can be set on internal commands such as COMMIT, ROLLBACK.
  2305. </summary>
  2306. </member>
  2307. <member name="M:Npgsql.NpgsqlConnector.#ctor(Npgsql.NpgsqlConnectionStringBuilder,System.String)">
  2308. <summary>
  2309. Creates a new connector with the given connection string.
  2310. </summary>
  2311. <param name="settings">The parsed connection string.</param>
  2312. <param name="connectionString">The connection string.</param>
  2313. </member>
  2314. <member name="P:Npgsql.NpgsqlConnector.State">
  2315. <summary>
  2316. Gets the current state of the connector
  2317. </summary>
  2318. </member>
  2319. <member name="P:Npgsql.NpgsqlConnector.IsConnected">
  2320. <summary>
  2321. Returns whether the connector is open, regardless of any task it is currently performing
  2322. </summary>
  2323. </member>
  2324. <member name="M:Npgsql.NpgsqlConnector.Open(Npgsql.NpgsqlTimeout,System.Boolean,System.Threading.CancellationToken)">
  2325. <summary>
  2326. Opens the physical connection to the server.
  2327. </summary>
  2328. <remarks>Usually called by the RequestConnector
  2329. Method of the connection pool manager.</remarks>
  2330. </member>
  2331. <member name="M:Npgsql.NpgsqlConnector.PrependInternalMessage(Npgsql.FrontendMessage)">
  2332. <summary>
  2333. Prepends a message to be sent at the beginning of the next message chain.
  2334. </summary>
  2335. </member>
  2336. <member name="M:Npgsql.NpgsqlConnector.SkipUntil(Npgsql.BackendMessageCode)">
  2337. <summary>
  2338. Reads backend messages and discards them, stopping only after a message of the given type has
  2339. been seen. Only a sync I/O version of this method exists - in async flows we inline the loop
  2340. rather than calling an additional async method, in order to avoid the overhead.
  2341. </summary>
  2342. </member>
  2343. <member name="M:Npgsql.NpgsqlConnector.ProcessNewTransactionStatus(Npgsql.TransactionStatus)">
  2344. <summary>
  2345. Handles a new transaction indicator received on a ReadyForQuery message
  2346. </summary>
  2347. </member>
  2348. <member name="P:Npgsql.NpgsqlConnector.IsSecure">
  2349. <summary>
  2350. Returns whether SSL is being used for the connection
  2351. </summary>
  2352. </member>
  2353. <member name="M:Npgsql.NpgsqlConnector.CancelRequest">
  2354. <summary>
  2355. Creates another connector and sends a cancel request through it for this connector.
  2356. </summary>
  2357. </member>
  2358. <member name="M:Npgsql.NpgsqlConnector.CloseOngoingOperations">
  2359. <summary>
  2360. Closes ongoing operations, i.e. an open reader exists or a COPY operation still in progress, as
  2361. part of a connection close.
  2362. Does nothing if the thread has been aborted - the connector will be closed immediately.
  2363. </summary>
  2364. </member>
  2365. <member name="M:Npgsql.NpgsqlConnector.UnexpectedMessageReceived(Npgsql.BackendMessageCode)">
  2366. <summary>
  2367. Called when an unexpected message has been received during an action. Breaks the
  2368. connector and returns the appropriate message.
  2369. </summary>
  2370. </member>
  2371. <member name="M:Npgsql.NpgsqlConnector.Break">
  2372. <summary>
  2373. Called when a connector becomes completely unusable, e.g. when an unexpected I/O exception is raised or when
  2374. we lose protocol sync.
  2375. Note that fatal errors during the Open phase do *not* pass through here.
  2376. </summary>
  2377. </member>
  2378. <member name="M:Npgsql.NpgsqlConnector.Cleanup">
  2379. <summary>
  2380. Closes the socket and cleans up client-side resources associated with this connector.
  2381. </summary>
  2382. </member>
  2383. <member name="M:Npgsql.NpgsqlConnector.Reset">
  2384. <summary>
  2385. Called when a pooled connection is closed, and its connector is returned to the pool.
  2386. Resets the connector back to its initial state, releasing server-side sources
  2387. (e.g. prepared statements), resetting parameters to their defaults, and resetting client-side
  2388. state
  2389. </summary>
  2390. <remarks>
  2391. It's important that this method be idempotent, since some race conditions in the pool
  2392. can cause it to be called twice (and also the user may close the connection right after
  2393. allocating it, without doing anything).
  2394. </remarks>
  2395. </member>
  2396. <member name="T:Npgsql.NpgsqlConnector.UserAction">
  2397. <summary>
  2398. An IDisposable wrapper around <see cref="M:Npgsql.NpgsqlConnector.EndUserAction"/>.
  2399. </summary>
  2400. </member>
  2401. <member name="P:Npgsql.NpgsqlConnector.Timezone">
  2402. <summary>
  2403. The connection's timezone as reported by PostgreSQL, in the IANA/Olson database format.
  2404. </summary>
  2405. </member>
  2406. <member name="T:Npgsql.ConnectorState">
  2407. <summary>
  2408. Expresses the exact state of a connector.
  2409. </summary>
  2410. </member>
  2411. <member name="F:Npgsql.ConnectorState.Closed">
  2412. <summary>
  2413. The connector has either not yet been opened or has been closed.
  2414. </summary>
  2415. </member>
  2416. <member name="F:Npgsql.ConnectorState.Connecting">
  2417. <summary>
  2418. The connector is currently connecting to a Postgresql server.
  2419. </summary>
  2420. </member>
  2421. <member name="F:Npgsql.ConnectorState.Ready">
  2422. <summary>
  2423. The connector is connected and may be used to send a new query.
  2424. </summary>
  2425. </member>
  2426. <member name="F:Npgsql.ConnectorState.Executing">
  2427. <summary>
  2428. The connector is waiting for a response to a query which has been sent to the server.
  2429. </summary>
  2430. </member>
  2431. <member name="F:Npgsql.ConnectorState.Fetching">
  2432. <summary>
  2433. The connector is currently fetching and processing query results.
  2434. </summary>
  2435. </member>
  2436. <member name="F:Npgsql.ConnectorState.Waiting">
  2437. <summary>
  2438. The connector is currently waiting for asynchronous notifications to arrive.
  2439. </summary>
  2440. </member>
  2441. <member name="F:Npgsql.ConnectorState.Broken">
  2442. <summary>
  2443. The connection was broken because an unexpected error occurred which left it in an unknown state.
  2444. This state isn't implemented yet.
  2445. </summary>
  2446. </member>
  2447. <member name="F:Npgsql.ConnectorState.Copy">
  2448. <summary>
  2449. The connector is engaged in a COPY operation.
  2450. </summary>
  2451. </member>
  2452. <member name="F:Npgsql.TransactionStatus.Idle">
  2453. <summary>
  2454. Currently not in a transaction block
  2455. </summary>
  2456. </member>
  2457. <member name="F:Npgsql.TransactionStatus.InTransactionBlock">
  2458. <summary>
  2459. Currently in a transaction block
  2460. </summary>
  2461. </member>
  2462. <member name="F:Npgsql.TransactionStatus.InFailedTransactionBlock">
  2463. <summary>
  2464. Currently in a failed transaction block (queries will be rejected until block is ended)
  2465. </summary>
  2466. </member>
  2467. <member name="F:Npgsql.TransactionStatus.Pending">
  2468. <summary>
  2469. A new transaction has been requested but not yet transmitted to the backend. It will be transmitted
  2470. prepended to the next query.
  2471. This is a client-side state option only, and is never transmitted from the backend.
  2472. </summary>
  2473. </member>
  2474. <member name="T:Npgsql.DataRowLoadingMode">
  2475. <summary>
  2476. Specifies how to load/parse DataRow messages as they're received from the backend.
  2477. </summary>
  2478. </member>
  2479. <member name="F:Npgsql.DataRowLoadingMode.NonSequential">
  2480. <summary>
  2481. Load DataRows in non-sequential mode
  2482. </summary>
  2483. </member>
  2484. <member name="F:Npgsql.DataRowLoadingMode.Sequential">
  2485. <summary>
  2486. Load DataRows in sequential mode
  2487. </summary>
  2488. </member>
  2489. <member name="F:Npgsql.DataRowLoadingMode.Skip">
  2490. <summary>
  2491. Skip DataRow messages altogether
  2492. </summary>
  2493. </member>
  2494. <member name="T:Npgsql.NpgsqlRowUpdatedEventHandler">
  2495. <summary>
  2496. Represents the method that handles the <see cref="E:Npgsql.NpgsqlDataAdapter.RowUpdated">RowUpdated</see> events.
  2497. </summary>
  2498. <param name="sender">The source of the event.</param>
  2499. <param name="e">A <see cref="T:Npgsql.NpgsqlRowUpdatedEventArgs">NpgsqlRowUpdatedEventArgs</see> that contains the event data.</param>
  2500. </member>
  2501. <member name="T:Npgsql.NpgsqlRowUpdatingEventHandler">
  2502. <summary>
  2503. Represents the method that handles the <see cref="E:Npgsql.NpgsqlDataAdapter.RowUpdating">RowUpdating</see> events.
  2504. </summary>
  2505. <param name="sender">The source of the event.</param>
  2506. <param name="e">A <see cref="T:Npgsql.NpgsqlRowUpdatingEventArgs">NpgsqlRowUpdatingEventArgs</see> that contains the event data.</param>
  2507. </member>
  2508. <member name="T:Npgsql.NpgsqlDataAdapter">
  2509. <summary>
  2510. This class represents an adapter from many commands: select, update, insert and delete to fill <see cref="T:System.Data.DataSet">Datasets.</see>
  2511. </summary>
  2512. </member>
  2513. <member name="E:Npgsql.NpgsqlDataAdapter.RowUpdated">
  2514. <summary>
  2515. Row updated event.
  2516. </summary>
  2517. </member>
  2518. <member name="E:Npgsql.NpgsqlDataAdapter.RowUpdating">
  2519. <summary>
  2520. Row updating event.
  2521. </summary>
  2522. </member>
  2523. <member name="M:Npgsql.NpgsqlDataAdapter.#ctor">
  2524. <summary>
  2525. Default constructor.
  2526. </summary>
  2527. </member>
  2528. <member name="M:Npgsql.NpgsqlDataAdapter.#ctor(Npgsql.NpgsqlCommand)">
  2529. <summary>
  2530. Constructor.
  2531. </summary>
  2532. <param name="selectCommand"></param>
  2533. </member>
  2534. <member name="M:Npgsql.NpgsqlDataAdapter.#ctor(System.String,Npgsql.NpgsqlConnection)">
  2535. <summary>
  2536. Constructor.
  2537. </summary>
  2538. <param name="selectCommandText"></param>
  2539. <param name="selectConnection"></param>
  2540. </member>
  2541. <member name="M:Npgsql.NpgsqlDataAdapter.#ctor(System.String,System.String)">
  2542. <summary>
  2543. Constructor.
  2544. </summary>
  2545. <param name="selectCommandText"></param>
  2546. <param name="selectConnectionString"></param>
  2547. </member>
  2548. <member name="M:Npgsql.NpgsqlDataAdapter.CreateRowUpdatedEvent(System.Data.DataRow,System.Data.IDbCommand,System.Data.StatementType,System.Data.Common.DataTableMapping)">
  2549. <summary>
  2550. Create row updated event.
  2551. </summary>
  2552. </member>
  2553. <member name="M:Npgsql.NpgsqlDataAdapter.CreateRowUpdatingEvent(System.Data.DataRow,System.Data.IDbCommand,System.Data.StatementType,System.Data.Common.DataTableMapping)">
  2554. <summary>
  2555. Create row updating event.
  2556. </summary>
  2557. </member>
  2558. <member name="M:Npgsql.NpgsqlDataAdapter.OnRowUpdated(System.Data.Common.RowUpdatedEventArgs)">
  2559. <summary>
  2560. Raise the RowUpdated event.
  2561. </summary>
  2562. <param name="value"></param>
  2563. </member>
  2564. <member name="M:Npgsql.NpgsqlDataAdapter.OnRowUpdating(System.Data.Common.RowUpdatingEventArgs)">
  2565. <summary>
  2566. Raise the RowUpdating event.
  2567. </summary>
  2568. <param name="value"></param>
  2569. </member>
  2570. <member name="P:Npgsql.NpgsqlDataAdapter.DeleteCommand">
  2571. <summary>
  2572. Delete command.
  2573. </summary>
  2574. </member>
  2575. <member name="P:Npgsql.NpgsqlDataAdapter.SelectCommand">
  2576. <summary>
  2577. Select command.
  2578. </summary>
  2579. </member>
  2580. <member name="P:Npgsql.NpgsqlDataAdapter.UpdateCommand">
  2581. <summary>
  2582. Update command.
  2583. </summary>
  2584. </member>
  2585. <member name="P:Npgsql.NpgsqlDataAdapter.InsertCommand">
  2586. <summary>
  2587. Insert command.
  2588. </summary>
  2589. </member>
  2590. <member name="T:Npgsql.NpgsqlDatabaseInfo">
  2591. <summary>
  2592. Base class for implementations which provide information about PostgreSQL and PostgreSQL-like databases
  2593. (e.g. type definitions, capabilities...).
  2594. </summary>
  2595. </member>
  2596. <member name="P:Npgsql.NpgsqlDatabaseInfo.Host">
  2597. <summary>
  2598. The hostname of IP address of the database.
  2599. </summary>
  2600. </member>
  2601. <member name="P:Npgsql.NpgsqlDatabaseInfo.Port">
  2602. <summary>
  2603. The TCP port of the database.
  2604. </summary>
  2605. </member>
  2606. <member name="P:Npgsql.NpgsqlDatabaseInfo.Name">
  2607. <summary>
  2608. The database name.
  2609. </summary>
  2610. </member>
  2611. <member name="P:Npgsql.NpgsqlDatabaseInfo.Version">
  2612. <summary>
  2613. The version of the PostgreSQL database we're connected to, as reported in the "server_version" parameter.
  2614. Exposed via <see cref="P:Npgsql.NpgsqlConnection.PostgreSqlVersion"/>.
  2615. </summary>
  2616. </member>
  2617. <member name="P:Npgsql.NpgsqlDatabaseInfo.SupportsRangeTypes">
  2618. <summary>
  2619. Whether the backend supports range types.
  2620. </summary>
  2621. </member>
  2622. <member name="P:Npgsql.NpgsqlDatabaseInfo.SupportsEnumTypes">
  2623. <summary>
  2624. Whether the backend supports enum types.
  2625. </summary>
  2626. </member>
  2627. <member name="P:Npgsql.NpgsqlDatabaseInfo.SupportsCloseAll">
  2628. <summary>
  2629. Whether the backend supports the CLOSE ALL statement.
  2630. </summary>
  2631. </member>
  2632. <member name="P:Npgsql.NpgsqlDatabaseInfo.SupportsAdvisoryLocks">
  2633. <summary>
  2634. Whether the backend supports advisory locks.
  2635. </summary>
  2636. </member>
  2637. <member name="P:Npgsql.NpgsqlDatabaseInfo.SupportsDiscardSequences">
  2638. <summary>
  2639. Whether the backend supports the DISCARD SEQUENCES statement.
  2640. </summary>
  2641. </member>
  2642. <member name="P:Npgsql.NpgsqlDatabaseInfo.SupportsUnlisten">
  2643. <summary>
  2644. Whether the backend supports the UNLISTEN statement.
  2645. </summary>
  2646. </member>
  2647. <member name="P:Npgsql.NpgsqlDatabaseInfo.SupportsDiscardTemp">
  2648. <summary>
  2649. Whether the backend supports the DISCARD TEMP statement.
  2650. </summary>
  2651. </member>
  2652. <member name="P:Npgsql.NpgsqlDatabaseInfo.SupportsDiscard">
  2653. <summary>
  2654. Whether the backend supports the DISCARD statement.
  2655. </summary>
  2656. </member>
  2657. <member name="P:Npgsql.NpgsqlDatabaseInfo.HasIntegerDateTimes">
  2658. <summary>
  2659. Reports whether the backend uses the newer integer timestamp representation.
  2660. </summary>
  2661. </member>
  2662. <member name="P:Npgsql.NpgsqlDatabaseInfo.SupportsTransactions">
  2663. <summary>
  2664. Whether the database supports transactions.
  2665. </summary>
  2666. </member>
  2667. <member name="P:Npgsql.NpgsqlDatabaseInfo.ByOID">
  2668. <summary>
  2669. Indexes backend types by their type OID.
  2670. </summary>
  2671. </member>
  2672. <member name="P:Npgsql.NpgsqlDatabaseInfo.ByFullName">
  2673. <summary>
  2674. Indexes backend types by their PostgreSQL name, including namespace (e.g. pg_catalog.int4).
  2675. Only used for enums and composites.
  2676. </summary>
  2677. </member>
  2678. <member name="P:Npgsql.NpgsqlDatabaseInfo.ByName">
  2679. <summary>
  2680. Indexes backend types by their PostgreSQL name, not including namespace.
  2681. If more than one type exists with the same name (i.e. in different namespaces) this
  2682. table will contain an entry with a null value.
  2683. Only used for enums and composites.
  2684. </summary>
  2685. </member>
  2686. <member name="M:Npgsql.NpgsqlDatabaseInfo.GetTypes">
  2687. <summary>
  2688. Provides all PostgreSQL types detected in this database.
  2689. </summary>
  2690. <returns></returns>
  2691. </member>
  2692. <member name="M:Npgsql.NpgsqlDatabaseInfo.ParseServerVersion(System.String)">
  2693. <summary>
  2694. Parses a PostgreSQL server version (e.g. 10.1, 9.6.3) and returns a CLR Version.
  2695. </summary>
  2696. </member>
  2697. <member name="M:Npgsql.NpgsqlDatabaseInfo.RegisterFactory(Npgsql.INpgsqlDatabaseInfoFactory)">
  2698. <summary>
  2699. Registers a new database info factory, which is used to load information about databases.
  2700. </summary>
  2701. </member>
  2702. <member name="T:Npgsql.NpgsqlDataReader">
  2703. <summary>
  2704. Reads a forward-only stream of rows from a data source.
  2705. </summary>
  2706. </member>
  2707. <member name="F:Npgsql.NpgsqlDataReader.Behavior">
  2708. <summary>
  2709. The behavior of the command with which this reader was executed.
  2710. </summary>
  2711. </member>
  2712. <member name="F:Npgsql.NpgsqlDataReader._statements">
  2713. <summary>
  2714. Holds the list of statements being executed by this reader.
  2715. </summary>
  2716. </member>
  2717. <member name="P:Npgsql.NpgsqlDataReader.StatementIndex">
  2718. <summary>
  2719. The index of the current query resultset we're processing (within a multiquery)
  2720. </summary>
  2721. </member>
  2722. <member name="F:Npgsql.NpgsqlDataReader.ColumnLen">
  2723. <summary>
  2724. For streaming types (e.g. bytea), holds the byte length of the column.
  2725. Does not include the length prefix.
  2726. </summary>
  2727. </member>
  2728. <member name="F:Npgsql.NpgsqlDataReader.RowDescription">
  2729. <summary>
  2730. The RowDescription message for the current resultset being processed
  2731. </summary>
  2732. </member>
  2733. <member name="F:Npgsql.NpgsqlDataReader._hasRows">
  2734. <summary>
  2735. Whether the current result set has rows
  2736. </summary>
  2737. </member>
  2738. <member name="E:Npgsql.NpgsqlDataReader.ReaderClosed">
  2739. <summary>
  2740. Is raised whenever Close() is called.
  2741. </summary>
  2742. </member>
  2743. <member name="F:Npgsql.NpgsqlDataReader.ColumnStream">
  2744. <summary>
  2745. A stream that has been opened on a column.
  2746. </summary>
  2747. </member>
  2748. <member name="F:Npgsql.NpgsqlDataReader._tempCharBuf">
  2749. <summary>
  2750. Used for internal temporary purposes
  2751. </summary>
  2752. </member>
  2753. <member name="M:Npgsql.NpgsqlDataReader.Read">
  2754. <summary>
  2755. Advances the reader to the next record in a result set.
  2756. </summary>
  2757. <returns><b>true</b> if there are more rows; otherwise <b>false</b>.</returns>
  2758. <remarks>
  2759. The default position of a data reader is before the first record. Therefore, you must call Read to begin accessing data.
  2760. </remarks>
  2761. </member>
  2762. <member name="M:Npgsql.NpgsqlDataReader.ReadAsync(System.Threading.CancellationToken)">
  2763. <summary>
  2764. This is the asynchronous version of <see cref="M:Npgsql.NpgsqlDataReader.Read"/> The cancellation token is currently ignored.
  2765. </summary>
  2766. <param name="cancellationToken">Ignored for now.</param>
  2767. <returns>A task representing the asynchronous operation.</returns>
  2768. </member>
  2769. <member name="M:Npgsql.NpgsqlDataReader.Read(System.Boolean)">
  2770. <summary>
  2771. Implementation of read
  2772. </summary>
  2773. </member>
  2774. <member name="M:Npgsql.NpgsqlDataReader.NextResult">
  2775. <summary>
  2776. Advances the reader to the next result when reading the results of a batch of statements.
  2777. </summary>
  2778. <returns></returns>
  2779. </member>
  2780. <member name="M:Npgsql.NpgsqlDataReader.NextResultAsync(System.Threading.CancellationToken)">
  2781. <summary>
  2782. This is the asynchronous version of NextResult.
  2783. The <paramref name="cancellationToken"/> parameter is currently ignored.
  2784. </summary>
  2785. <param name="cancellationToken">Currently ignored.</param>
  2786. <returns>A task representing the asynchronous operation.</returns>
  2787. </member>
  2788. <member name="M:Npgsql.NpgsqlDataReader.NextResult(System.Boolean,System.Boolean)">
  2789. <summary>
  2790. Internal implementation of NextResult
  2791. </summary>
  2792. </member>
  2793. <member name="M:Npgsql.NpgsqlDataReader.NextResultSchemaOnly(System.Boolean)">
  2794. <summary>
  2795. Note that in SchemaOnly mode there are no resultsets, and we read nothing from the backend (all
  2796. RowDescriptions have already been processed and are available)
  2797. </summary>
  2798. </member>
  2799. <member name="P:Npgsql.NpgsqlDataReader.Depth">
  2800. <summary>
  2801. Gets a value indicating the depth of nesting for the current row. Always returns zero.
  2802. </summary>
  2803. </member>
  2804. <member name="P:Npgsql.NpgsqlDataReader.IsClosed">
  2805. <summary>
  2806. Gets a value indicating whether the data reader is closed.
  2807. </summary>
  2808. </member>
  2809. <member name="P:Npgsql.NpgsqlDataReader.RecordsAffected">
  2810. <summary>
  2811. Gets the number of rows changed, inserted, or deleted by execution of the SQL statement.
  2812. </summary>
  2813. </member>
  2814. <member name="P:Npgsql.NpgsqlDataReader.Statements">
  2815. <summary>
  2816. Returns details about each statement that this reader will or has executed.
  2817. </summary>
  2818. <remarks>
  2819. Note that some fields (i.e. rows and oid) are only populated as the reader
  2820. traverses the result.
  2821. For commands with multiple queries, this exposes the number of rows affected on
  2822. a statement-by-statement basis, unlike <see cref="P:Npgsql.NpgsqlDataReader.RecordsAffected"/>
  2823. which exposes an aggregation across all statements.
  2824. </remarks>
  2825. </member>
  2826. <member name="P:Npgsql.NpgsqlDataReader.HasRows">
  2827. <summary>
  2828. Gets a value that indicates whether this DbDataReader contains one or more rows.
  2829. </summary>
  2830. </member>
  2831. <member name="P:Npgsql.NpgsqlDataReader.IsOnRow">
  2832. <summary>
  2833. Indicates whether the reader is currently positioned on a row, i.e. whether reading a
  2834. column is possible.
  2835. This property is different from <see cref="P:Npgsql.NpgsqlDataReader.HasRows"/> in that <see cref="P:Npgsql.NpgsqlDataReader.HasRows"/> will
  2836. return true even if attempting to read a column will fail, e.g. before <see cref="M:Npgsql.NpgsqlDataReader.Read"/>
  2837. has been called
  2838. </summary>
  2839. </member>
  2840. <member name="M:Npgsql.NpgsqlDataReader.GetName(System.Int32)">
  2841. <summary>
  2842. Gets the name of the column, given the zero-based column ordinal.
  2843. </summary>
  2844. <param name="ordinal">The zero-based column ordinal.</param>
  2845. <returns>The name of the specified column.</returns>
  2846. </member>
  2847. <member name="P:Npgsql.NpgsqlDataReader.FieldCount">
  2848. <summary>
  2849. Gets the number of columns in the current row.
  2850. </summary>
  2851. </member>
  2852. <member name="M:Npgsql.NpgsqlDataReader.Consume(System.Boolean)">
  2853. <summary>
  2854. Consumes all result sets for this reader, leaving the connector ready for sending and processing further
  2855. queries
  2856. </summary>
  2857. </member>
  2858. <member name="M:Npgsql.NpgsqlDataReader.Dispose(System.Boolean)">
  2859. <summary>
  2860. Releases the resources used by the <see cref="T:Npgsql.NpgsqlDataReader">NpgsqlDataReader</see>.
  2861. </summary>
  2862. </member>
  2863. <member name="M:Npgsql.NpgsqlDataReader.Close">
  2864. <summary>
  2865. Closes the <see cref="T:Npgsql.NpgsqlDataReader"/> reader, allowing a new command to be executed.
  2866. </summary>
  2867. </member>
  2868. <member name="M:Npgsql.NpgsqlDataReader.CloseAsync">
  2869. <summary>
  2870. Closes the <see cref="T:Npgsql.NpgsqlDataReader"/> reader, allowing a new command to be executed.
  2871. </summary>
  2872. </member>
  2873. <member name="M:Npgsql.NpgsqlDataReader.GetBoolean(System.Int32)">
  2874. <summary>
  2875. Gets the value of the specified column as a Boolean.
  2876. </summary>
  2877. <param name="ordinal">The zero-based column ordinal.</param>
  2878. <returns>The value of the specified column.</returns>
  2879. </member>
  2880. <member name="M:Npgsql.NpgsqlDataReader.GetByte(System.Int32)">
  2881. <summary>
  2882. Gets the value of the specified column as a byte.
  2883. </summary>
  2884. <param name="ordinal">The zero-based column ordinal.</param>
  2885. <returns>The value of the specified column.</returns>
  2886. </member>
  2887. <member name="M:Npgsql.NpgsqlDataReader.GetChar(System.Int32)">
  2888. <summary>
  2889. Gets the value of the specified column as a single character.
  2890. </summary>
  2891. <param name="ordinal">The zero-based column ordinal.</param>
  2892. <returns>The value of the specified column.</returns>
  2893. </member>
  2894. <member name="M:Npgsql.NpgsqlDataReader.GetInt16(System.Int32)">
  2895. <summary>
  2896. Gets the value of the specified column as a 16-bit signed integer.
  2897. </summary>
  2898. <param name="ordinal">The zero-based column ordinal.</param>
  2899. <returns>The value of the specified column.</returns>
  2900. </member>
  2901. <member name="M:Npgsql.NpgsqlDataReader.GetInt32(System.Int32)">
  2902. <summary>
  2903. Gets the value of the specified column as a 32-bit signed integer.
  2904. </summary>
  2905. <param name="ordinal">The zero-based column ordinal.</param>
  2906. <returns>The value of the specified column.</returns>
  2907. </member>
  2908. <member name="M:Npgsql.NpgsqlDataReader.GetInt64(System.Int32)">
  2909. <summary>
  2910. Gets the value of the specified column as a 64-bit signed integer.
  2911. </summary>
  2912. <param name="ordinal">The zero-based column ordinal.</param>
  2913. <returns>The value of the specified column.</returns>
  2914. </member>
  2915. <member name="M:Npgsql.NpgsqlDataReader.GetDateTime(System.Int32)">
  2916. <summary>
  2917. Gets the value of the specified column as a <see cref="T:System.DateTime"/> object.
  2918. </summary>
  2919. <param name="ordinal">The zero-based column ordinal.</param>
  2920. <returns>The value of the specified column.</returns>
  2921. </member>
  2922. <member name="M:Npgsql.NpgsqlDataReader.GetString(System.Int32)">
  2923. <summary>
  2924. Gets the value of the specified column as an instance of <see cref="T:System.String"/>.
  2925. </summary>
  2926. <param name="ordinal">The zero-based column ordinal.</param>
  2927. <returns>The value of the specified column.</returns>
  2928. </member>
  2929. <member name="M:Npgsql.NpgsqlDataReader.GetDecimal(System.Int32)">
  2930. <summary>
  2931. Gets the value of the specified column as a <see cref="T:System.Decimal"/> object.
  2932. </summary>
  2933. <param name="ordinal">The zero-based column ordinal.</param>
  2934. <returns>The value of the specified column.</returns>
  2935. </member>
  2936. <member name="M:Npgsql.NpgsqlDataReader.GetDouble(System.Int32)">
  2937. <summary>
  2938. Gets the value of the specified column as a double-precision floating point number.
  2939. </summary>
  2940. <param name="ordinal">The zero-based column ordinal.</param>
  2941. <returns>The value of the specified column.</returns>
  2942. </member>
  2943. <member name="M:Npgsql.NpgsqlDataReader.GetFloat(System.Int32)">
  2944. <summary>
  2945. Gets the value of the specified column as a single-precision floating point number.
  2946. </summary>
  2947. <param name="ordinal">The zero-based column ordinal.</param>
  2948. <returns>The value of the specified column.</returns>
  2949. </member>
  2950. <member name="M:Npgsql.NpgsqlDataReader.GetGuid(System.Int32)">
  2951. <summary>
  2952. Gets the value of the specified column as a globally-unique identifier (GUID).
  2953. </summary>
  2954. <param name="ordinal">The zero-based column ordinal.</param>
  2955. <returns>The value of the specified column.</returns>
  2956. </member>
  2957. <member name="M:Npgsql.NpgsqlDataReader.GetValues(System.Object[])">
  2958. <summary>
  2959. Populates an array of objects with the column values of the current row.
  2960. </summary>
  2961. <param name="values">An array of Object into which to copy the attribute columns.</param>
  2962. <returns>The number of instances of <see cref="T:System.Object"/> in the array.</returns>
  2963. </member>
  2964. <member name="P:Npgsql.NpgsqlDataReader.Item(System.Int32)">
  2965. <summary>
  2966. Gets the value of the specified column as an instance of <see cref="T:System.Object"/>.
  2967. </summary>
  2968. <param name="ordinal">The zero-based column ordinal.</param>
  2969. <returns>The value of the specified column.</returns>
  2970. </member>
  2971. <member name="M:Npgsql.NpgsqlDataReader.GetDate(System.Int32)">
  2972. <summary>
  2973. Gets the value of the specified column as an <see cref="T:NpgsqlTypes.NpgsqlDate"/>,
  2974. Npgsql's provider-specific type for dates.
  2975. </summary>
  2976. <remarks>
  2977. PostgreSQL's date type represents dates from 4713 BC to 5874897 AD, while .NET's DateTime
  2978. only supports years from 1 to 1999. If you require years outside this range use this accessor.
  2979. The standard <see cref="M:System.Data.Common.DbDataReader.GetProviderSpecificValue(System.Int32)"/> method will also return this type, but has
  2980. the disadvantage of boxing the value.
  2981. See http://www.postgresql.org/docs/current/static/datatype-datetime.html
  2982. </remarks>
  2983. <param name="ordinal">The zero-based column ordinal.</param>
  2984. <returns>The value of the specified column.</returns>
  2985. </member>
  2986. <member name="M:Npgsql.NpgsqlDataReader.GetTimeSpan(System.Int32)">
  2987. <summary>
  2988. Gets the value of the specified column as a TimeSpan,
  2989. </summary>
  2990. <remarks>
  2991. PostgreSQL's interval type has has a resolution of 1 microsecond and ranges from
  2992. -178000000 to 178000000 years, while .NET's TimeSpan has a resolution of 100 nanoseconds
  2993. and ranges from roughly -29247 to 29247 years.
  2994. See http://www.postgresql.org/docs/current/static/datatype-datetime.html
  2995. </remarks>
  2996. <param name="ordinal">The zero-based column ordinal.</param>
  2997. <returns>The value of the specified column.</returns>
  2998. </member>
  2999. <member name="M:Npgsql.NpgsqlDataReader.GetInterval(System.Int32)">
  3000. <summary>
  3001. Gets the value of the specified column as an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>,
  3002. Npgsql's provider-specific type for time spans.
  3003. </summary>
  3004. <remarks>
  3005. PostgreSQL's interval type has has a resolution of 1 microsecond and ranges from
  3006. -178000000 to 178000000 years, while .NET's TimeSpan has a resolution of 100 nanoseconds
  3007. and ranges from roughly -29247 to 29247 years. If you require values from outside TimeSpan's
  3008. range use this accessor.
  3009. The standard ADO.NET <see cref="M:System.Data.Common.DbDataReader.GetProviderSpecificValue(System.Int32)"/> method will also return this
  3010. type, but has the disadvantage of boxing the value.
  3011. See http://www.postgresql.org/docs/current/static/datatype-datetime.html
  3012. </remarks>
  3013. <param name="ordinal">The zero-based column ordinal.</param>
  3014. <returns>The value of the specified column.</returns>
  3015. </member>
  3016. <member name="M:Npgsql.NpgsqlDataReader.GetTimeStamp(System.Int32)">
  3017. <summary>
  3018. Gets the value of the specified column as an <see cref="T:NpgsqlTypes.NpgsqlDateTime"/>,
  3019. Npgsql's provider-specific type for date/time timestamps. Note that this type covers
  3020. both PostgreSQL's "timestamp with time zone" and "timestamp without time zone" types,
  3021. which differ only in how they are converted upon input/output.
  3022. </summary>
  3023. <remarks>
  3024. PostgreSQL's timestamp type represents dates from 4713 BC to 5874897 AD, while .NET's DateTime
  3025. only supports years from 1 to 1999. If you require years outside this range use this accessor.
  3026. The standard <see cref="M:System.Data.Common.DbDataReader.GetProviderSpecificValue(System.Int32)"/> method will also return this type, but has
  3027. the disadvantage of boxing the value.
  3028. See http://www.postgresql.org/docs/current/static/datatype-datetime.html
  3029. </remarks>
  3030. <param name="ordinal">The zero-based column ordinal.</param>
  3031. <returns>The value of the specified column.</returns>
  3032. </member>
  3033. <member name="M:Npgsql.NpgsqlDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)">
  3034. <summary>
  3035. 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.
  3036. </summary>
  3037. <param name="ordinal">The zero-based column ordinal.</param>
  3038. <param name="dataOffset">The index within the row from which to begin the read operation.</param>
  3039. <param name="buffer">The buffer into which to copy the data.</param>
  3040. <param name="bufferOffset">The index with the buffer to which the data will be copied.</param>
  3041. <param name="length">The maximum number of characters to read.</param>
  3042. <returns>The actual number of bytes read.</returns>
  3043. </member>
  3044. <member name="M:Npgsql.NpgsqlDataReader.GetStream(System.Int32)">
  3045. <summary>
  3046. Retrieves data as a <see cref="T:System.IO.Stream"/>.
  3047. </summary>
  3048. <param name="ordinal">The zero-based column ordinal.</param>
  3049. <returns>The returned object.</returns>
  3050. </member>
  3051. <member name="M:Npgsql.NpgsqlDataReader.GetStreamAsync(System.Int32)">
  3052. <summary>
  3053. Retrieves data as a <see cref="T:System.IO.Stream"/>.
  3054. </summary>
  3055. <param name="ordinal">The zero-based column ordinal.</param>
  3056. <returns>The returned object.</returns>
  3057. </member>
  3058. <member name="M:Npgsql.NpgsqlDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)">
  3059. <summary>
  3060. 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.
  3061. </summary>
  3062. <param name="ordinal">The zero-based column ordinal.</param>
  3063. <param name="dataOffset">The index within the row from which to begin the read operation.</param>
  3064. <param name="buffer">The buffer into which to copy the data.</param>
  3065. <param name="bufferOffset">The index with the buffer to which the data will be copied.</param>
  3066. <param name="length">The maximum number of characters to read.</param>
  3067. <returns>The actual number of characters read.</returns>
  3068. </member>
  3069. <member name="M:Npgsql.NpgsqlDataReader.GetTextReader(System.Int32)">
  3070. <summary>
  3071. Retrieves data as a <see cref="T:System.IO.TextReader"/>.
  3072. </summary>
  3073. <param name="ordinal">The zero-based column ordinal.</param>
  3074. <returns>The returned object.</returns>
  3075. </member>
  3076. <member name="M:Npgsql.NpgsqlDataReader.GetTextReaderAsync(System.Int32)">
  3077. <summary>
  3078. Retrieves data as a <see cref="T:System.IO.TextReader"/>.
  3079. </summary>
  3080. <param name="ordinal">The zero-based column ordinal.</param>
  3081. <returns>The returned object.</returns>
  3082. </member>
  3083. <member name="P:Npgsql.NpgsqlDataReader.Item(System.String)">
  3084. <summary>
  3085. Gets the value of the specified column as an instance of <see cref="T:System.Object"/>.
  3086. </summary>
  3087. <param name="name">The name of the column.</param>
  3088. <returns>The value of the specified column.</returns>
  3089. </member>
  3090. <member name="M:Npgsql.NpgsqlDataReader.GetOrdinal(System.String)">
  3091. <summary>
  3092. Gets the column ordinal given the name of the column.
  3093. </summary>
  3094. <param name="name">The name of the column.</param>
  3095. <returns>The zero-based column ordinal.</returns>
  3096. </member>
  3097. <member name="M:Npgsql.NpgsqlDataReader.GetPostgresType(System.Int32)">
  3098. <summary>
  3099. Gets a representation of the PostgreSQL data type for the specified field.
  3100. The returned representation can be used to access various information about the field.
  3101. </summary>
  3102. <param name="ordinal">The zero-based column index.</param>
  3103. </member>
  3104. <member name="M:Npgsql.NpgsqlDataReader.GetDataTypeName(System.Int32)">
  3105. <summary>
  3106. Gets the data type information for the specified field.
  3107. This will be the PostgreSQL type name (e.g. double precision), not the .NET type
  3108. (see <see cref="M:Npgsql.NpgsqlDataReader.GetFieldType(System.Int32)"/> for that).
  3109. </summary>
  3110. <param name="ordinal">The zero-based column index.</param>
  3111. </member>
  3112. <member name="M:Npgsql.NpgsqlDataReader.GetDataTypeOID(System.Int32)">
  3113. <summary>
  3114. Gets the OID for the PostgreSQL type for the specified field, as it appears in the pg_type table.
  3115. </summary>
  3116. <remarks>
  3117. This is a PostgreSQL-internal value that should not be relied upon and should only be used for
  3118. debugging purposes.
  3119. </remarks>
  3120. <param name="ordinal">The zero-based column index.</param>
  3121. </member>
  3122. <member name="M:Npgsql.NpgsqlDataReader.GetFieldType(System.Int32)">
  3123. <summary>
  3124. Gets the data type of the specified column.
  3125. </summary>
  3126. <param name="ordinal">The zero-based column ordinal.</param>
  3127. <returns>The data type of the specified column.</returns>
  3128. </member>
  3129. <member name="M:Npgsql.NpgsqlDataReader.GetProviderSpecificFieldType(System.Int32)">
  3130. <summary>
  3131. Returns the provider-specific field type of the specified column.
  3132. </summary>
  3133. <param name="ordinal">The zero-based column ordinal.</param>
  3134. <returns>The Type object that describes the data type of the specified column.</returns>
  3135. </member>
  3136. <member name="M:Npgsql.NpgsqlDataReader.GetProviderSpecificValues(System.Object[])">
  3137. <summary>
  3138. Gets all provider-specific attribute columns in the collection for the current row.
  3139. </summary>
  3140. <param name="values">An array of Object into which to copy the attribute columns.</param>
  3141. <returns>The number of instances of <see cref="T:System.Object"/> in the array.</returns>
  3142. </member>
  3143. <member name="M:Npgsql.NpgsqlDataReader.GetEnumerator">
  3144. <summary>
  3145. Returns an <see cref="T:System.Collections.IEnumerator"/> that can be used to iterate through the rows in the data reader.
  3146. </summary>
  3147. <returns>An <see cref="T:System.Collections.IEnumerator"/> that can be used to iterate through the rows in the data reader.</returns>
  3148. </member>
  3149. <member name="M:Npgsql.NpgsqlDataReader.GetColumnSchema">
  3150. <summary>
  3151. Returns schema information for the columns in the current resultset.
  3152. </summary>
  3153. <returns></returns>
  3154. </member>
  3155. <member name="M:Npgsql.NpgsqlDataReader.GetSchemaTable">
  3156. <summary>
  3157. Returns a System.Data.DataTable that describes the column metadata of the DataReader.
  3158. </summary>
  3159. </member>
  3160. <member name="T:Npgsql.NpgsqlDefaultDataReader">
  3161. <summary>
  3162. The default, non-sequential reader, which buffers entire rows in memory.
  3163. </summary>
  3164. </member>
  3165. <member name="F:Npgsql.NpgsqlDefaultDataReader._column">
  3166. <summary>
  3167. The number of columns in the current row
  3168. </summary>
  3169. </member>
  3170. <member name="M:Npgsql.NpgsqlDefaultDataReader.GetValue(System.Int32)">
  3171. <summary>
  3172. Gets the value of the specified column as an instance of <see cref="T:System.Object"/>.
  3173. </summary>
  3174. <param name="ordinal">The zero-based column ordinal.</param>
  3175. <returns>The value of the specified column.</returns>
  3176. </member>
  3177. <member name="M:Npgsql.NpgsqlDefaultDataReader.GetProviderSpecificValue(System.Int32)">
  3178. <summary>
  3179. Gets the value of the specified column as an instance of <see cref="T:System.Object"/>.
  3180. </summary>
  3181. <param name="ordinal">The zero-based column ordinal.</param>
  3182. <returns>The value of the specified column.</returns>
  3183. </member>
  3184. <member name="M:Npgsql.NpgsqlDefaultDataReader.IsDBNull(System.Int32)">
  3185. <summary>
  3186. Gets a value that indicates whether the column contains nonexistent or missing values.
  3187. </summary>
  3188. <param name="ordinal">The zero-based column ordinal.</param>
  3189. <returns><b>true</b> if the specified column is equivalent to <see cref="T:System.DBNull"/>; otherwise <b>false</b>.</returns>
  3190. </member>
  3191. <member name="T:Npgsql.NpgsqlException">
  3192. <summary>
  3193. The exception that is thrown when server-related issues occur.
  3194. </summary>
  3195. <remarks>
  3196. PostgreSQL errors (e.g. query SQL issues, constraint violations) are raised via
  3197. <see cref="T:Npgsql.PostgresException"/> which is a subclass of this class.
  3198. Purely Npgsql-related issues which aren't related to the server will be raised
  3199. via the standard CLR exceptions (e.g. ArgumentException).
  3200. </remarks>
  3201. </member>
  3202. <member name="M:Npgsql.NpgsqlException.#ctor">
  3203. <summary>
  3204. Initializes a new instance of the <see cref="T:Npgsql.NpgsqlException"/> class.
  3205. </summary>
  3206. </member>
  3207. <member name="M:Npgsql.NpgsqlException.#ctor(System.String,System.Exception)">
  3208. <summary>
  3209. 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.
  3210. </summary>
  3211. <param name="message">The error message that explains the reason for the exception.</param>
  3212. <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>
  3213. </member>
  3214. <member name="M:Npgsql.NpgsqlException.#ctor(System.String)">
  3215. <summary>
  3216. Initializes a new instance of the <see cref="T:Npgsql.NpgsqlException"/> class with a specified error message.
  3217. </summary>
  3218. <param name="message">The message that describes the error.</param>
  3219. </member>
  3220. <member name="P:Npgsql.NpgsqlException.IsTransient">
  3221. <summary>
  3222. Specifies whether the exception is considered transient, that is, whether retrying to operation could
  3223. succeed (e.g. a network error).
  3224. </summary>
  3225. </member>
  3226. <member name="M:Npgsql.NpgsqlException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  3227. <summary>
  3228. Initializes a new instance of the <see cref="T:Npgsql.NpgsqlException"/> class with serialized data.
  3229. </summary>
  3230. <param name="info">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>
  3231. <param name="context">The StreamingContext that contains contextual information about the source or destination.</param>
  3232. </member>
  3233. <member name="T:Npgsql.NpgsqlFactory">
  3234. <summary>
  3235. A factory to create instances of various Npgsql objects.
  3236. </summary>
  3237. </member>
  3238. <member name="F:Npgsql.NpgsqlFactory.Instance">
  3239. <summary>
  3240. Gets an instance of the <see cref="T:Npgsql.NpgsqlFactory"/>.
  3241. This can be used to retrieve strongly typed data objects.
  3242. </summary>
  3243. </member>
  3244. <member name="M:Npgsql.NpgsqlFactory.CreateCommand">
  3245. <summary>
  3246. Returns a strongly typed <see cref="T:System.Data.Common.DbCommand"/> instance.
  3247. </summary>
  3248. </member>
  3249. <member name="M:Npgsql.NpgsqlFactory.CreateConnection">
  3250. <summary>
  3251. Returns a strongly typed <see cref="T:System.Data.Common.DbConnection"/> instance.
  3252. </summary>
  3253. </member>
  3254. <member name="M:Npgsql.NpgsqlFactory.CreateParameter">
  3255. <summary>
  3256. Returns a strongly typed <see cref="T:System.Data.Common.DbParameter"/> instance.
  3257. </summary>
  3258. </member>
  3259. <member name="M:Npgsql.NpgsqlFactory.CreateConnectionStringBuilder">
  3260. <summary>
  3261. Returns a strongly typed <see cref="T:System.Data.Common.DbConnectionStringBuilder"/> instance.
  3262. </summary>
  3263. </member>
  3264. <member name="M:Npgsql.NpgsqlFactory.CreateCommandBuilder">
  3265. <summary>
  3266. Returns a strongly typed <see cref="T:System.Data.Common.DbCommandBuilder"/> instance.
  3267. </summary>
  3268. </member>
  3269. <member name="M:Npgsql.NpgsqlFactory.CreateDataAdapter">
  3270. <summary>
  3271. Returns a strongly typed <see cref="T:System.Data.Common.DbDataAdapter"/> instance.
  3272. </summary>
  3273. </member>
  3274. <member name="M:Npgsql.NpgsqlFactory.GetService(System.Type)">
  3275. <summary>
  3276. Gets the service object of the specified type.
  3277. </summary>
  3278. <param name="serviceType">An object that specifies the type of service object to get.</param>
  3279. <returns>A service object of type serviceType, or null if there is no service object of type serviceType.</returns>
  3280. </member>
  3281. <member name="T:Npgsql.NpgsqlLargeObjectManager">
  3282. <summary>
  3283. Large object manager. This class can be used to store very large files in a PostgreSQL database.
  3284. </summary>
  3285. </member>
  3286. <member name="P:Npgsql.NpgsqlLargeObjectManager.MaxTransferBlockSize">
  3287. <summary>
  3288. The largest chunk size (in bytes) read and write operations will read/write each roundtrip to the network. Default 4 MB.
  3289. </summary>
  3290. </member>
  3291. <member name="M:Npgsql.NpgsqlLargeObjectManager.#ctor(Npgsql.NpgsqlConnection)">
  3292. <summary>
  3293. Creates an NpgsqlLargeObjectManager for this connection. The connection must be opened to perform remote operations.
  3294. </summary>
  3295. <param name="connection"></param>
  3296. </member>
  3297. <member name="M:Npgsql.NpgsqlLargeObjectManager.ExecuteFunction``1(System.String,System.Boolean,System.Object[])">
  3298. <summary>
  3299. Execute a function
  3300. </summary>
  3301. </member>
  3302. <member name="M:Npgsql.NpgsqlLargeObjectManager.ExecuteFunctionGetBytes(System.String,System.Byte[],System.Int32,System.Int32,System.Boolean,System.Object[])">
  3303. <summary>
  3304. Execute a function that returns a byte array
  3305. </summary>
  3306. <returns></returns>
  3307. </member>
  3308. <member name="M:Npgsql.NpgsqlLargeObjectManager.Create(System.UInt32)">
  3309. <summary>
  3310. Create an empty large object in the database. If an oid is specified but is already in use, an PostgresException will be thrown.
  3311. </summary>
  3312. <param name="preferredOid">A preferred oid, or specify 0 if one should be automatically assigned</param>
  3313. <returns>The oid for the large object created</returns>
  3314. <exception cref="T:Npgsql.PostgresException">If an oid is already in use</exception>
  3315. </member>
  3316. <member name="M:Npgsql.NpgsqlLargeObjectManager.CreateAsync(System.UInt32,System.Threading.CancellationToken)">
  3317. <summary>
  3318. Create an empty large object in the database. If an oid is specified but is already in use, an PostgresException will be thrown.
  3319. </summary>
  3320. <param name="preferredOid">A preferred oid, or specify 0 if one should be automatically assigned</param>
  3321. <param name="cancellationToken">Cancellation token.</param>
  3322. <returns>The oid for the large object created</returns>
  3323. <exception cref="T:Npgsql.PostgresException">If an oid is already in use</exception>
  3324. </member>
  3325. <member name="M:Npgsql.NpgsqlLargeObjectManager.OpenRead(System.UInt32)">
  3326. <summary>
  3327. Opens a large object on the backend, returning a stream controlling this remote object.
  3328. A transaction snapshot is taken by the backend when the object is opened with only read permissions.
  3329. When reading from this object, the contents reflects the time when the snapshot was taken.
  3330. Note that this method, as well as operations on the stream must be wrapped inside a transaction.
  3331. </summary>
  3332. <param name="oid">Oid of the object</param>
  3333. <returns>An NpgsqlLargeObjectStream</returns>
  3334. </member>
  3335. <member name="M:Npgsql.NpgsqlLargeObjectManager.OpenReadAsync(System.UInt32,System.Threading.CancellationToken)">
  3336. <summary>
  3337. Opens a large object on the backend, returning a stream controlling this remote object.
  3338. A transaction snapshot is taken by the backend when the object is opened with only read permissions.
  3339. When reading from this object, the contents reflects the time when the snapshot was taken.
  3340. Note that this method, as well as operations on the stream must be wrapped inside a transaction.
  3341. </summary>
  3342. <param name="oid">Oid of the object</param>
  3343. <param name="cancellationToken">Cancellation token.</param>
  3344. <returns>An NpgsqlLargeObjectStream</returns>
  3345. </member>
  3346. <member name="M:Npgsql.NpgsqlLargeObjectManager.OpenReadWrite(System.UInt32)">
  3347. <summary>
  3348. Opens a large object on the backend, returning a stream controlling this remote object.
  3349. Note that this method, as well as operations on the stream must be wrapped inside a transaction.
  3350. </summary>
  3351. <param name="oid">Oid of the object</param>
  3352. <returns>An NpgsqlLargeObjectStream</returns>
  3353. </member>
  3354. <member name="M:Npgsql.NpgsqlLargeObjectManager.OpenReadWriteAsync(System.UInt32,System.Threading.CancellationToken)">
  3355. <summary>
  3356. Opens a large object on the backend, returning a stream controlling this remote object.
  3357. Note that this method, as well as operations on the stream must be wrapped inside a transaction.
  3358. </summary>
  3359. <param name="oid">Oid of the object</param>
  3360. <param name="cancellationToken">Cancellation token.</param>
  3361. <returns>An NpgsqlLargeObjectStream</returns>
  3362. </member>
  3363. <member name="M:Npgsql.NpgsqlLargeObjectManager.Unlink(System.UInt32)">
  3364. <summary>
  3365. Deletes a large object on the backend.
  3366. </summary>
  3367. <param name="oid">Oid of the object to delete</param>
  3368. </member>
  3369. <member name="M:Npgsql.NpgsqlLargeObjectManager.UnlinkAsync(System.UInt32,System.Threading.CancellationToken)">
  3370. <summary>
  3371. Deletes a large object on the backend.
  3372. </summary>
  3373. <param name="oid">Oid of the object to delete</param>
  3374. <param name="cancellationToken">Cancellation token.</param>
  3375. </member>
  3376. <member name="M:Npgsql.NpgsqlLargeObjectManager.ExportRemote(System.UInt32,System.String)">
  3377. <summary>
  3378. Exports a large object stored in the database to a file on the backend. This requires superuser permissions.
  3379. </summary>
  3380. <param name="oid">Oid of the object to export</param>
  3381. <param name="path">Path to write the file on the backend</param>
  3382. </member>
  3383. <member name="M:Npgsql.NpgsqlLargeObjectManager.ExportRemoteAsync(System.UInt32,System.String,System.Threading.CancellationToken)">
  3384. <summary>
  3385. Exports a large object stored in the database to a file on the backend. This requires superuser permissions.
  3386. </summary>
  3387. <param name="oid">Oid of the object to export</param>
  3388. <param name="path">Path to write the file on the backend</param>
  3389. <param name="cancellationToken">Cancellation token.</param>
  3390. </member>
  3391. <member name="M:Npgsql.NpgsqlLargeObjectManager.ImportRemote(System.String,System.UInt32)">
  3392. <summary>
  3393. 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.
  3394. </summary>
  3395. <param name="path">Path to read the file on the backend</param>
  3396. <param name="oid">A preferred oid, or specify 0 if one should be automatically assigned</param>
  3397. </member>
  3398. <member name="M:Npgsql.NpgsqlLargeObjectManager.ImportRemoteAsync(System.String,System.UInt32,System.Threading.CancellationToken)">
  3399. <summary>
  3400. 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.
  3401. </summary>
  3402. <param name="path">Path to read the file on the backend</param>
  3403. <param name="oid">A preferred oid, or specify 0 if one should be automatically assigned</param>
  3404. <param name="cancellationToken">Cancellation token.</param>
  3405. </member>
  3406. <member name="P:Npgsql.NpgsqlLargeObjectManager.Has64BitSupport">
  3407. <summary>
  3408. Since PostgreSQL 9.3, large objects larger than 2GB can be handled, up to 4TB.
  3409. This property returns true whether the PostgreSQL version is >= 9.3.
  3410. </summary>
  3411. </member>
  3412. <member name="T:Npgsql.NpgsqlLargeObjectStream">
  3413. <summary>
  3414. An interface to remotely control the seekable stream for an opened large object on a PostgreSQL server.
  3415. Note that the OpenRead/OpenReadWrite method as well as all operations performed on this stream must be wrapped inside a database transaction.
  3416. </summary>
  3417. </member>
  3418. <member name="P:Npgsql.NpgsqlLargeObjectStream.Has64BitSupport">
  3419. <summary>
  3420. Since PostgreSQL 9.3, large objects larger than 2GB can be handled, up to 4TB.
  3421. This property returns true whether the PostgreSQL version is >= 9.3.
  3422. </summary>
  3423. </member>
  3424. <member name="M:Npgsql.NpgsqlLargeObjectStream.Read(System.Byte[],System.Int32,System.Int32)">
  3425. <summary>
  3426. Reads <i>count</i> bytes from the large object. The only case when fewer bytes are read is when end of stream is reached.
  3427. </summary>
  3428. <param name="buffer">The buffer where read data should be stored.</param>
  3429. <param name="offset">The offset in the buffer where the first byte should be read.</param>
  3430. <param name="count">The maximum number of bytes that should be read.</param>
  3431. <returns>How many bytes actually read, or 0 if end of file was already reached.</returns>
  3432. </member>
  3433. <member name="M:Npgsql.NpgsqlLargeObjectStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  3434. <summary>
  3435. Reads <i>count</i> bytes from the large object. The only case when fewer bytes are read is when end of stream is reached.
  3436. </summary>
  3437. <param name="buffer">The buffer where read data should be stored.</param>
  3438. <param name="offset">The offset in the buffer where the first byte should be read.</param>
  3439. <param name="count">The maximum number of bytes that should be read.</param>
  3440. <param name="cancellationToken">Cancellation token</param>
  3441. <returns>How many bytes actually read, or 0 if end of file was already reached.</returns>
  3442. </member>
  3443. <member name="M:Npgsql.NpgsqlLargeObjectStream.Write(System.Byte[],System.Int32,System.Int32)">
  3444. <summary>
  3445. Writes <i>count</i> bytes to the large object.
  3446. </summary>
  3447. <param name="buffer">The buffer to write data from.</param>
  3448. <param name="offset">The offset in the buffer at which to begin copying bytes.</param>
  3449. <param name="count">The number of bytes to write.</param>
  3450. </member>
  3451. <member name="M:Npgsql.NpgsqlLargeObjectStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  3452. <summary>
  3453. Writes <i>count</i> bytes to the large object.
  3454. </summary>
  3455. <param name="buffer">The buffer to write data from.</param>
  3456. <param name="offset">The offset in the buffer at which to begin copying bytes.</param>
  3457. <param name="count">The number of bytes to write.</param>
  3458. <param name="cancellationToken">Cancellation token.</param>
  3459. </member>
  3460. <member name="P:Npgsql.NpgsqlLargeObjectStream.CanTimeout">
  3461. <summary>
  3462. CanTimeout always returns false.
  3463. </summary>
  3464. </member>
  3465. <member name="P:Npgsql.NpgsqlLargeObjectStream.CanRead">
  3466. <summary>
  3467. CanRead always returns true, unless the stream has been closed.
  3468. </summary>
  3469. </member>
  3470. <member name="P:Npgsql.NpgsqlLargeObjectStream.CanWrite">
  3471. <summary>
  3472. CanWrite returns true if the stream was opened with write permissions, and the stream has not been closed.
  3473. </summary>
  3474. </member>
  3475. <member name="P:Npgsql.NpgsqlLargeObjectStream.CanSeek">
  3476. <summary>
  3477. CanSeek always returns true, unless the stream has been closed.
  3478. </summary>
  3479. </member>
  3480. <member name="P:Npgsql.NpgsqlLargeObjectStream.Position">
  3481. <summary>
  3482. 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.
  3483. </summary>
  3484. </member>
  3485. <member name="P:Npgsql.NpgsqlLargeObjectStream.Length">
  3486. <summary>
  3487. Gets the length of the large object. This internally seeks to the end of the stream to retrieve the length, and then back again.
  3488. </summary>
  3489. </member>
  3490. <member name="M:Npgsql.NpgsqlLargeObjectStream.GetLengthAsync">
  3491. <summary>
  3492. Gets the length of the large object. This internally seeks to the end of the stream to retrieve the length, and then back again.
  3493. </summary>
  3494. </member>
  3495. <member name="M:Npgsql.NpgsqlLargeObjectStream.Seek(System.Int64,System.IO.SeekOrigin)">
  3496. <summary>
  3497. Seeks in the stream to the specified position. This requires a round-trip to the backend.
  3498. </summary>
  3499. <param name="offset">A byte offset relative to the <i>origin</i> parameter.</param>
  3500. <param name="origin">A value of type SeekOrigin indicating the reference point used to obtain the new position.</param>
  3501. <returns></returns>
  3502. </member>
  3503. <member name="M:Npgsql.NpgsqlLargeObjectStream.SeekAsync(System.Int64,System.IO.SeekOrigin,System.Threading.CancellationToken)">
  3504. <summary>
  3505. Seeks in the stream to the specified position. This requires a round-trip to the backend.
  3506. </summary>
  3507. <param name="offset">A byte offset relative to the <i>origin</i> parameter.</param>
  3508. <param name="origin">A value of type SeekOrigin indicating the reference point used to obtain the new position.</param>
  3509. <param name="cancellationToken">Cancellation token.</param>
  3510. <returns></returns>
  3511. </member>
  3512. <member name="M:Npgsql.NpgsqlLargeObjectStream.Flush">
  3513. <summary>
  3514. Does nothing.
  3515. </summary>
  3516. </member>
  3517. <member name="M:Npgsql.NpgsqlLargeObjectStream.SetLength(System.Int64)">
  3518. <summary>
  3519. Truncates or enlarges the large object to the given size. If enlarging, the large object is extended with null bytes.
  3520. For PostgreSQL versions earlier than 9.3, the value must fit in an Int32.
  3521. </summary>
  3522. <param name="value">Number of bytes to either truncate or enlarge the large object.</param>
  3523. </member>
  3524. <member name="M:Npgsql.NpgsqlLargeObjectStream.SetLength(System.Int64,System.Threading.CancellationToken)">
  3525. <summary>
  3526. Truncates or enlarges the large object to the given size. If enlarging, the large object is extended with null bytes.
  3527. For PostgreSQL versions earlier than 9.3, the value must fit in an Int32.
  3528. </summary>
  3529. <param name="value">Number of bytes to either truncate or enlarge the large object.</param>
  3530. <param name="cancellationToken">Cancellation token.</param>
  3531. </member>
  3532. <member name="M:Npgsql.NpgsqlLargeObjectStream.Close">
  3533. <summary>
  3534. Releases resources at the backend allocated for this stream.
  3535. </summary>
  3536. </member>
  3537. <member name="M:Npgsql.NpgsqlLargeObjectStream.Dispose(System.Boolean)">
  3538. <summary>
  3539. Releases resources at the backend allocated for this stream, iff disposing is true.
  3540. </summary>
  3541. <param name="disposing">Whether to release resources allocated at the backend.</param>
  3542. </member>
  3543. <member name="T:Npgsql.NpgsqlLengthCache">
  3544. <summary>
  3545. An array of cached lengths for the parameters sending process.
  3546. When sending parameters, lengths need to be calculated more than once (once for Bind, once for
  3547. an array, once for the string within that array). This cache optimized that. Lengths are added
  3548. to the cache, and then retrieved at the same order.
  3549. </summary>
  3550. </member>
  3551. <member name="M:Npgsql.NpgsqlLengthCache.Set(System.Int32)">
  3552. <summary>
  3553. Stores a length value in the cache, to be fetched later via <see cref="M:Npgsql.NpgsqlLengthCache.Get"/>.
  3554. Called at the <see cref="M:Npgsql.TypeHandling.NpgsqlTypeHandler.ValidateAndGetLength``1(``0,Npgsql.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)"/> phase.
  3555. </summary>
  3556. <returns>The length parameter.</returns>
  3557. </member>
  3558. <member name="M:Npgsql.NpgsqlLengthCache.Get">
  3559. <summary>
  3560. Retrieves a length value previously stored in the cache via <see cref="M:Npgsql.NpgsqlLengthCache.Set(System.Int32)"/>.
  3561. Called at the writing phase, after validation has already occurred and the length cache is populated.
  3562. </summary>
  3563. <returns></returns>
  3564. </member>
  3565. <member name="T:Npgsql.NpgsqlNotificationEventArgs">
  3566. <summary>
  3567. Provides information on a PostgreSQL notification. Notifications are sent when your connection has registered for
  3568. notifications on a specific channel via the LISTEN command. NOTIFY can be used to generate such notifications,
  3569. allowing for an inter-connection communication channel.
  3570. </summary>
  3571. </member>
  3572. <member name="P:Npgsql.NpgsqlNotificationEventArgs.PID">
  3573. <summary>
  3574. Process ID of the PostgreSQL backend that sent this notification.
  3575. </summary>
  3576. </member>
  3577. <member name="P:Npgsql.NpgsqlNotificationEventArgs.Condition">
  3578. <summary>
  3579. The channel on which the notification was sent.
  3580. </summary>
  3581. </member>
  3582. <member name="P:Npgsql.NpgsqlNotificationEventArgs.AdditionalInformation">
  3583. <summary>
  3584. An optional payload string that was sent with this notification.
  3585. </summary>
  3586. </member>
  3587. <member name="T:Npgsql.NpgsqlOperationInProgressException">
  3588. <summary>
  3589. Thrown when trying to use a connection that is already busy performing some other operation.
  3590. Provides information on the already-executing operation to help with debugging.
  3591. </summary>
  3592. </member>
  3593. <member name="P:Npgsql.NpgsqlOperationInProgressException.CommandInProgress">
  3594. <summary>
  3595. If the connection is busy with another command, this will contain a reference to that command.
  3596. Otherwise, if the connection if busy with another type of operation (e.g. COPY), contains null.
  3597. </summary>
  3598. </member>
  3599. <member name="T:Npgsql.NpgsqlParameter">
  3600. <summary>
  3601. This class represents a parameter to a command that will be sent to server
  3602. </summary>
  3603. </member>
  3604. <member name="P:Npgsql.NpgsqlParameter.ConvertedValue">
  3605. <summary>
  3606. Can be used to communicate a value from the validation phase to the writing phase.
  3607. To be used by type handlers only.
  3608. </summary>
  3609. </member>
  3610. <member name="M:Npgsql.NpgsqlParameter.#ctor">
  3611. <summary>
  3612. Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> class.
  3613. </summary>
  3614. </member>
  3615. <member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,System.Object)">
  3616. <summary>
  3617. Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>
  3618. class with the parameter name and a value of the new <b>NpgsqlParameter</b>.
  3619. </summary>
  3620. <param name="parameterName">The name of the parameter to map.</param>
  3621. <param name="value">An <see cref="T:System.Object">Object</see> that is the value of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.</param>
  3622. <remarks>
  3623. <p>When you specify an <see cref="T:System.Object">Object</see>
  3624. in the value parameter, the <see cref="T:System.Data.DbType">DbType</see> is
  3625. inferred from the .NET Framework type of the <b>Object</b>.</p>
  3626. <p>When using this constructor, you must be aware of a possible misuse of the constructor which takes a DbType parameter.
  3627. This happens when calling this constructor passing an int 0 and the compiler thinks you are passing a value of DbType.
  3628. Use <code> Convert.ToInt32(value) </code> for example to have compiler calling the correct constructor.</p>
  3629. </remarks>
  3630. </member>
  3631. <member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,NpgsqlTypes.NpgsqlDbType)">
  3632. <summary>
  3633. Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>
  3634. class with the parameter name and the data type.
  3635. </summary>
  3636. <param name="parameterName">The name of the parameter to map.</param>
  3637. <param name="parameterType">One of the <see cref="T:System.Data.DbType">DbType</see> values.</param>
  3638. </member>
  3639. <member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,System.Data.DbType)">
  3640. <summary>
  3641. Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.
  3642. </summary>
  3643. <param name="parameterName">The name of the parameter to map.</param>
  3644. <param name="parameterType">One of the <see cref="T:System.Data.DbType">DbType</see> values.</param>
  3645. </member>
  3646. <member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32)">
  3647. <summary>
  3648. Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.
  3649. </summary>
  3650. <param name="parameterName">The name of the parameter to map.</param>
  3651. <param name="parameterType">One of the <see cref="T:NpgsqlTypes.NpgsqlDbType">NpgsqlDbType</see> values.</param>
  3652. <param name="size">The length of the parameter.</param>
  3653. </member>
  3654. <member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,System.Data.DbType,System.Int32)">
  3655. <summary>
  3656. Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.
  3657. </summary>
  3658. <param name="parameterName">The name of the parameter to map.</param>
  3659. <param name="parameterType">One of the <see cref="T:System.Data.DbType">DbType</see> values.</param>
  3660. <param name="size">The length of the parameter.</param>
  3661. </member>
  3662. <member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32,System.String)">
  3663. <summary>
  3664. Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>
  3665. </summary>
  3666. <param name="parameterName">The name of the parameter to map.</param>
  3667. <param name="parameterType">One of the <see cref="T:NpgsqlTypes.NpgsqlDbType">NpgsqlDbType</see> values.</param>
  3668. <param name="size">The length of the parameter.</param>
  3669. <param name="sourceColumn">The name of the source column.</param>
  3670. </member>
  3671. <member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,System.Data.DbType,System.Int32,System.String)">
  3672. <summary>
  3673. Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.
  3674. </summary>
  3675. <param name="parameterName">The name of the parameter to map.</param>
  3676. <param name="parameterType">One of the <see cref="T:System.Data.DbType">DbType</see> values.</param>
  3677. <param name="size">The length of the parameter.</param>
  3678. <param name="sourceColumn">The name of the source column.</param>
  3679. </member>
  3680. <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)">
  3681. <summary>
  3682. Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.
  3683. </summary>
  3684. <param name="parameterName">The name of the parameter to map.</param>
  3685. <param name="parameterType">One of the <see cref="T:NpgsqlTypes.NpgsqlDbType">NpgsqlDbType</see> values.</param>
  3686. <param name="size">The length of the parameter.</param>
  3687. <param name="sourceColumn">The name of the source column.</param>
  3688. <param name="direction">One of the <see cref="T:System.Data.ParameterDirection">ParameterDirection</see> values.</param>
  3689. <param name="isNullable"><b>true</b> if the value of the field can be null, otherwise <b>false</b>.</param>
  3690. <param name="precision">The total number of digits to the left and right of the decimal point to which
  3691. <see cref="P:Npgsql.NpgsqlParameter.Value">Value</see> is resolved.</param>
  3692. <param name="scale">The total number of decimal places to which
  3693. <see cref="P:Npgsql.NpgsqlParameter.Value">Value</see> is resolved.</param>
  3694. <param name="sourceVersion">One of the <see cref="T:System.Data.DataRowVersion">DataRowVersion</see> values.</param>
  3695. <param name="value">An <see cref="T:System.Object">Object</see> that is the value
  3696. of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.</param>
  3697. </member>
  3698. <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)">
  3699. <summary>
  3700. Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.
  3701. </summary>
  3702. <param name="parameterName">The name of the parameter to map.</param>
  3703. <param name="parameterType">One of the <see cref="T:System.Data.DbType">DbType</see> values.</param>
  3704. <param name="size">The length of the parameter.</param>
  3705. <param name="sourceColumn">The name of the source column.</param>
  3706. <param name="direction">One of the <see cref="T:System.Data.ParameterDirection">ParameterDirection</see> values.</param>
  3707. <param name="isNullable"><b>true</b> if the value of the field can be null, otherwise <b>false</b>.</param>
  3708. <param name="precision">The total number of digits to the left and right of the decimal point to which
  3709. <see cref="P:Npgsql.NpgsqlParameter.Value">Value</see> is resolved.</param>
  3710. <param name="scale">The total number of decimal places to which
  3711. <see cref="P:Npgsql.NpgsqlParameter.Value">Value</see> is resolved.</param>
  3712. <param name="sourceVersion">One of the <see cref="T:System.Data.DataRowVersion">DataRowVersion</see> values.</param>
  3713. <param name="value">An <see cref="T:System.Object">Object</see> that is the value
  3714. of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.</param>
  3715. </member>
  3716. <member name="P:Npgsql.NpgsqlParameter.ParameterName">
  3717. <summary>
  3718. Gets or sets The name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.
  3719. </summary>
  3720. <value>The name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.
  3721. The default is an empty string.</value>
  3722. </member>
  3723. <member name="P:Npgsql.NpgsqlParameter.Value">
  3724. <inheritdoc />
  3725. </member>
  3726. <member name="P:Npgsql.NpgsqlParameter.NpgsqlValue">
  3727. <summary>
  3728. Gets or sets the value of the parameter.
  3729. </summary>
  3730. <value>An <see cref="T:System.Object">Object</see> that is the value of the parameter.
  3731. The default value is null.</value>
  3732. </member>
  3733. <member name="P:Npgsql.NpgsqlParameter.DbType">
  3734. <summary>
  3735. Gets or sets the <see cref="T:System.Data.DbType">DbType</see> of the parameter.
  3736. </summary>
  3737. <value>One of the <see cref="T:System.Data.DbType">DbType</see> values. The default is <b>Object</b>.</value>
  3738. </member>
  3739. <member name="P:Npgsql.NpgsqlParameter.NpgsqlDbType">
  3740. <summary>
  3741. Gets or sets the <see cref="T:NpgsqlTypes.NpgsqlDbType">NpgsqlDbType</see> of the parameter.
  3742. </summary>
  3743. <value>One of the <see cref="T:NpgsqlTypes.NpgsqlDbType">NpgsqlDbType</see> values. The default is <b>Unknown</b>.</value>
  3744. </member>
  3745. <member name="P:Npgsql.NpgsqlParameter.DataTypeName">
  3746. <summary>
  3747. Used to specify which PostgreSQL type will be sent to the database for this parameter.
  3748. </summary>
  3749. </member>
  3750. <member name="P:Npgsql.NpgsqlParameter.IsNullable">
  3751. <inheritdoc />
  3752. </member>
  3753. <member name="P:Npgsql.NpgsqlParameter.Direction">
  3754. <inheritdoc />
  3755. </member>
  3756. <member name="P:Npgsql.NpgsqlParameter.Precision">
  3757. <summary>
  3758. Gets or sets the maximum number of digits used to represent the
  3759. <see cref="P:Npgsql.NpgsqlParameter.Value">Value</see> property.
  3760. </summary>
  3761. <value>The maximum number of digits used to represent the
  3762. <see cref="P:Npgsql.NpgsqlParameter.Value">Value</see> property.
  3763. The default value is 0, which indicates that the data provider
  3764. sets the precision for <b>Value</b>.</value>
  3765. </member>
  3766. <member name="P:Npgsql.NpgsqlParameter.Scale">
  3767. <summary>
  3768. Gets or sets the number of decimal places to which
  3769. <see cref="P:Npgsql.NpgsqlParameter.Value">Value</see> is resolved.
  3770. </summary>
  3771. <value>The number of decimal places to which
  3772. <see cref="P:Npgsql.NpgsqlParameter.Value">Value</see> is resolved. The default is 0.</value>
  3773. </member>
  3774. <member name="P:Npgsql.NpgsqlParameter.Size">
  3775. <inheritdoc />
  3776. </member>
  3777. <member name="P:Npgsql.NpgsqlParameter.SourceColumn">
  3778. <inheritdoc />
  3779. </member>
  3780. <member name="P:Npgsql.NpgsqlParameter.SourceVersion">
  3781. <inheritdoc />
  3782. </member>
  3783. <member name="P:Npgsql.NpgsqlParameter.SourceColumnNullMapping">
  3784. <inheritdoc />
  3785. </member>
  3786. <member name="P:Npgsql.NpgsqlParameter.Collection">
  3787. <summary>
  3788. The collection to which this parameter belongs, if any.
  3789. </summary>
  3790. </member>
  3791. <member name="P:Npgsql.NpgsqlParameter.PostgresType">
  3792. <summary>
  3793. The PostgreSQL data type, such as int4 or text, as discovered from pg_type.
  3794. This property is automatically set if parameters have been derived via
  3795. <see cref="M:Npgsql.NpgsqlCommandBuilder.DeriveParameters(Npgsql.NpgsqlCommand)"/> and can be used to
  3796. acquire additional information about the parameters' data type.
  3797. </summary>
  3798. </member>
  3799. <member name="P:Npgsql.NpgsqlParameter.IsTypeExplicitlySet">
  3800. <summary>
  3801. Returns whether this parameter has had its type set explicitly via DbType or NpgsqlDbType
  3802. (and not via type inference)
  3803. </summary>
  3804. </member>
  3805. <member name="M:Npgsql.NpgsqlParameter.ResetDbType">
  3806. <inheritdoc />
  3807. </member>
  3808. <member name="M:Npgsql.NpgsqlParameter.Clone">
  3809. <summary>
  3810. Creates a new <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> that
  3811. is a copy of the current instance.
  3812. </summary>
  3813. <returns>A new <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> that is a copy of this instance.</returns>
  3814. </member>
  3815. <member name="T:Npgsql.NpgsqlParameterCollection">
  3816. <summary>
  3817. Represents a collection of parameters relevant to a <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see>
  3818. as well as their respective mappings to columns in a DataSet.
  3819. This class cannot be inherited.
  3820. </summary>
  3821. </member>
  3822. <member name="M:Npgsql.NpgsqlParameterCollection.#ctor">
  3823. <summary>
  3824. Initializes a new instance of the NpgsqlParameterCollection class.
  3825. </summary>
  3826. </member>
  3827. <member name="M:Npgsql.NpgsqlParameterCollection.InvalidateHashLookups">
  3828. <summary>
  3829. Invalidate the hash lookup tables. This should be done any time a change
  3830. may throw the lookups out of sync with the list.
  3831. </summary>
  3832. </member>
  3833. <member name="P:Npgsql.NpgsqlParameterCollection.Item(System.String)">
  3834. <summary>
  3835. Gets the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> with the specified name.
  3836. </summary>
  3837. <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to retrieve.</param>
  3838. <value>The <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> with the specified name, or a null reference if the parameter is not found.</value>
  3839. </member>
  3840. <member name="P:Npgsql.NpgsqlParameterCollection.Item(System.Int32)">
  3841. <summary>
  3842. Gets the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> at the specified index.
  3843. </summary>
  3844. <param name="index">The zero-based index of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to retrieve.</param>
  3845. <value>The <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> at the specified index.</value>
  3846. </member>
  3847. <member name="M:Npgsql.NpgsqlParameterCollection.Add(Npgsql.NpgsqlParameter)">
  3848. <summary>
  3849. Adds the specified <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object to the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see>.
  3850. </summary>
  3851. <param name="value">The <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to add to the collection.</param>
  3852. <returns>The index of the new <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object.</returns>
  3853. </member>
  3854. <member name="M:Npgsql.NpgsqlParameterCollection.System#Collections#Generic#ICollection{Npgsql#NpgsqlParameter}#Add(Npgsql.NpgsqlParameter)">
  3855. <inheritdoc />
  3856. </member>
  3857. <member name="M:Npgsql.NpgsqlParameterCollection.AddWithValue(System.String,System.Object)">
  3858. <summary>
  3859. Adds a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see> given the specified parameter name and value.
  3860. </summary>
  3861. <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.</param>
  3862. <param name="value">The Value of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to add to the collection.</param>
  3863. <returns>The paramater that was added.</returns>
  3864. </member>
  3865. <member name="M:Npgsql.NpgsqlParameterCollection.AddWithValue(System.String,NpgsqlTypes.NpgsqlDbType,System.Object)">
  3866. <summary>
  3867. Adds a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see> given the specified parameter name, data type and value.
  3868. </summary>
  3869. <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.</param>
  3870. <param name="parameterType">One of the NpgsqlDbType values.</param>
  3871. <param name="value">The Value of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to add to the collection.</param>
  3872. <returns>The paramater that was added.</returns>
  3873. </member>
  3874. <member name="M:Npgsql.NpgsqlParameterCollection.AddWithValue(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32,System.Object)">
  3875. <summary>
  3876. Adds a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see> given the specified parameter name and value.
  3877. </summary>
  3878. <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.</param>
  3879. <param name="value">The Value of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to add to the collection.</param>
  3880. <param name="parameterType">One of the NpgsqlDbType values.</param>
  3881. <param name="size">The length of the column.</param>
  3882. <returns>The paramater that was added.</returns>
  3883. </member>
  3884. <member name="M:Npgsql.NpgsqlParameterCollection.AddWithValue(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32,System.String,System.Object)">
  3885. <summary>
  3886. Adds a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see> given the specified parameter name and value.
  3887. </summary>
  3888. <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.</param>
  3889. <param name="value">The Value of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to add to the collection.</param>
  3890. <param name="parameterType">One of the NpgsqlDbType values.</param>
  3891. <param name="size">The length of the column.</param>
  3892. <param name="sourceColumn">The name of the source column.</param>
  3893. <returns>The paramater that was added.</returns>
  3894. </member>
  3895. <member name="M:Npgsql.NpgsqlParameterCollection.AddWithValue(System.Object)">
  3896. <summary>
  3897. Adds a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see> given the specified value.
  3898. </summary>
  3899. <param name="value">The Value of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to add to the collection.</param>
  3900. <returns>The paramater that was added.</returns>
  3901. </member>
  3902. <member name="M:Npgsql.NpgsqlParameterCollection.AddWithValue(NpgsqlTypes.NpgsqlDbType,System.Object)">
  3903. <summary>
  3904. Adds a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see> given the specified data type and value.
  3905. </summary>
  3906. <param name="parameterType">One of the NpgsqlDbType values.</param>
  3907. <param name="value">The Value of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to add to the collection.</param>
  3908. <returns>The paramater that was added.</returns>
  3909. </member>
  3910. <member name="M:Npgsql.NpgsqlParameterCollection.Add(System.String,NpgsqlTypes.NpgsqlDbType)">
  3911. <summary>
  3912. Adds a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see> given the parameter name and the data type.
  3913. </summary>
  3914. <param name="parameterName">The name of the parameter.</param>
  3915. <param name="parameterType">One of the DbType values.</param>
  3916. <returns>The index of the new <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object.</returns>
  3917. </member>
  3918. <member name="M:Npgsql.NpgsqlParameterCollection.Add(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32)">
  3919. <summary>
  3920. Adds a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see> with the parameter name, the data type, and the column length.
  3921. </summary>
  3922. <param name="parameterName">The name of the parameter.</param>
  3923. <param name="parameterType">One of the DbType values.</param>
  3924. <param name="size">The length of the column.</param>
  3925. <returns>The index of the new <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object.</returns>
  3926. </member>
  3927. <member name="M:Npgsql.NpgsqlParameterCollection.Add(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32,System.String)">
  3928. <summary>
  3929. Adds a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see> with the parameter name, the data type, the column length, and the source column name.
  3930. </summary>
  3931. <param name="parameterName">The name of the parameter.</param>
  3932. <param name="parameterType">One of the DbType values.</param>
  3933. <param name="size">The length of the column.</param>
  3934. <param name="sourceColumn">The name of the source column.</param>
  3935. <returns>The index of the new <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object.</returns>
  3936. </member>
  3937. <member name="M:Npgsql.NpgsqlParameterCollection.RemoveAt(System.String)">
  3938. <inheritdoc />
  3939. </member>
  3940. <member name="M:Npgsql.NpgsqlParameterCollection.Contains(System.String)">
  3941. <inheritdoc />
  3942. </member>
  3943. <member name="M:Npgsql.NpgsqlParameterCollection.IndexOf(System.String)">
  3944. <inheritdoc />
  3945. </member>
  3946. <member name="P:Npgsql.NpgsqlParameterCollection.IsReadOnly">
  3947. <inheritdoc />
  3948. </member>
  3949. <member name="M:Npgsql.NpgsqlParameterCollection.RemoveAt(System.Int32)">
  3950. <summary>
  3951. Removes the specified <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> from the collection using a specific index.
  3952. </summary>
  3953. <param name="index">The zero-based index of the parameter.</param>
  3954. </member>
  3955. <member name="M:Npgsql.NpgsqlParameterCollection.Insert(System.Int32,System.Object)">
  3956. <inheritdoc />
  3957. </member>
  3958. <member name="M:Npgsql.NpgsqlParameterCollection.Remove(System.String)">
  3959. <summary>
  3960. Removes the specified <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> from the collection.
  3961. </summary>
  3962. <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to remove from the collection.</param>
  3963. </member>
  3964. <member name="M:Npgsql.NpgsqlParameterCollection.Remove(System.Object)">
  3965. <summary>
  3966. Removes the specified <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> from the collection.
  3967. </summary>
  3968. <param name="value">The <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> to remove from the collection.</param>
  3969. </member>
  3970. <member name="M:Npgsql.NpgsqlParameterCollection.Contains(System.Object)">
  3971. <inheritdoc />
  3972. </member>
  3973. <member name="M:Npgsql.NpgsqlParameterCollection.TryGetValue(System.String,Npgsql.NpgsqlParameter@)">
  3974. <summary>
  3975. Gets a value indicating whether a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> with the specified parameter name exists in the collection.
  3976. </summary>
  3977. <param name="parameterName">The name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object to find.</param>
  3978. <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 null if the parameter is not found.</param>
  3979. <returns><b>true</b> if the collection contains the parameter and param will contain the parameter; otherwise, <b>false</b>.</returns>
  3980. </member>
  3981. <member name="M:Npgsql.NpgsqlParameterCollection.Clear">
  3982. <summary>
  3983. Removes all items from the collection.
  3984. </summary>
  3985. </member>
  3986. <member name="M:Npgsql.NpgsqlParameterCollection.IndexOf(System.Object)">
  3987. <inheritdoc />
  3988. </member>
  3989. <member name="M:Npgsql.NpgsqlParameterCollection.Add(System.Object)">
  3990. <inheritdoc />
  3991. </member>
  3992. <member name="P:Npgsql.NpgsqlParameterCollection.IsFixedSize">
  3993. <inheritdoc />
  3994. </member>
  3995. <member name="P:Npgsql.NpgsqlParameterCollection.IsSynchronized">
  3996. <inheritdoc />
  3997. </member>
  3998. <member name="P:Npgsql.NpgsqlParameterCollection.Count">
  3999. <summary>
  4000. Gets the number of <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> objects in the collection.
  4001. </summary>
  4002. <value>The number of <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> objects in the collection.</value>
  4003. </member>
  4004. <member name="M:Npgsql.NpgsqlParameterCollection.CopyTo(System.Array,System.Int32)">
  4005. <inheritdoc />
  4006. </member>
  4007. <member name="P:Npgsql.NpgsqlParameterCollection.System#Collections#Generic#ICollection{Npgsql#NpgsqlParameter}#IsReadOnly">
  4008. <inheritdoc />
  4009. </member>
  4010. <member name="P:Npgsql.NpgsqlParameterCollection.SyncRoot">
  4011. <inheritdoc />
  4012. </member>
  4013. <member name="M:Npgsql.NpgsqlParameterCollection.GetEnumerator">
  4014. <inheritdoc />
  4015. </member>
  4016. <member name="M:Npgsql.NpgsqlParameterCollection.AddRange(System.Array)">
  4017. <inheritdoc />
  4018. </member>
  4019. <member name="M:Npgsql.NpgsqlParameterCollection.GetParameter(System.String)">
  4020. <inheritdoc />
  4021. </member>
  4022. <member name="M:Npgsql.NpgsqlParameterCollection.GetParameter(System.Int32)">
  4023. <inheritdoc />
  4024. </member>
  4025. <member name="M:Npgsql.NpgsqlParameterCollection.SetParameter(System.String,System.Data.Common.DbParameter)">
  4026. <inheritdoc />
  4027. </member>
  4028. <member name="M:Npgsql.NpgsqlParameterCollection.SetParameter(System.Int32,System.Data.Common.DbParameter)">
  4029. <inheritdoc />
  4030. </member>
  4031. <member name="M:Npgsql.NpgsqlParameterCollection.IndexOf(Npgsql.NpgsqlParameter)">
  4032. <summary>
  4033. Report the offset within the collection of the given parameter.
  4034. </summary>
  4035. <param name="item">Parameter to find.</param>
  4036. <returns>Index of the parameter, or -1 if the parameter is not present.</returns>
  4037. </member>
  4038. <member name="M:Npgsql.NpgsqlParameterCollection.Insert(System.Int32,Npgsql.NpgsqlParameter)">
  4039. <summary>
  4040. Insert the specified parameter into the collection.
  4041. </summary>
  4042. <param name="index">Index of the existing parameter before which to insert the new one.</param>
  4043. <param name="item">Parameter to insert.</param>
  4044. </member>
  4045. <member name="M:Npgsql.NpgsqlParameterCollection.Contains(Npgsql.NpgsqlParameter)">
  4046. <summary>
  4047. Report whether the specified parameter is present in the collection.
  4048. </summary>
  4049. <param name="item">Parameter to find.</param>
  4050. <returns>True if the parameter was found, otherwise false.</returns>
  4051. </member>
  4052. <member name="M:Npgsql.NpgsqlParameterCollection.Remove(Npgsql.NpgsqlParameter)">
  4053. <summary>
  4054. Remove the specified parameter from the collection.
  4055. </summary>
  4056. <param name="item">Parameter to remove.</param>
  4057. <returns>True if the parameter was found and removed, otherwise false.</returns>
  4058. </member>
  4059. <member name="M:Npgsql.NpgsqlParameterCollection.CopyTo(Npgsql.NpgsqlParameter[],System.Int32)">
  4060. <summary>
  4061. Convert collection to a System.Array.
  4062. </summary>
  4063. <param name="array">Destination array.</param>
  4064. <param name="arrayIndex">Starting index in destination array.</param>
  4065. </member>
  4066. <member name="M:Npgsql.NpgsqlParameterCollection.ToArray">
  4067. <summary>
  4068. Convert collection to a System.Array.
  4069. </summary>
  4070. <returns>NpgsqlParameter[]</returns>
  4071. </member>
  4072. <member name="T:Npgsql.NpgsqlParameter`1">
  4073. <summary>
  4074. A generic version of <see cref="T:Npgsql.NpgsqlParameter"/> which provides more type safety and
  4075. avoids boxing of value types. Use <see cref="P:Npgsql.NpgsqlParameter`1.TypedValue"/> instead of <see cref="P:Npgsql.NpgsqlParameter.Value"/>.
  4076. </summary>
  4077. <typeparam name="T">The type of the value that will be stored in the parameter.</typeparam>
  4078. </member>
  4079. <member name="P:Npgsql.NpgsqlParameter`1.TypedValue">
  4080. <summary>
  4081. Gets or sets the strongly-typed value of the parameter.
  4082. </summary>
  4083. </member>
  4084. <member name="P:Npgsql.NpgsqlParameter`1.Value">
  4085. <summary>
  4086. Gets or sets the value of the parameter. This delegates to <see cref="P:Npgsql.NpgsqlParameter`1.TypedValue"/>.
  4087. </summary>
  4088. </member>
  4089. <member name="M:Npgsql.NpgsqlParameter`1.#ctor">
  4090. <summary>
  4091. Initializes a new instance of <see cref="T:Npgsql.NpgsqlParameter`1" />.
  4092. </summary>
  4093. </member>
  4094. <member name="M:Npgsql.NpgsqlParameter`1.#ctor(System.String,`0)">
  4095. <summary>
  4096. Initializes a new instance of <see cref="T:Npgsql.NpgsqlParameter`1" /> with a parameter name and value.
  4097. </summary>
  4098. </member>
  4099. <member name="M:Npgsql.NpgsqlParameter`1.#ctor(System.String,NpgsqlTypes.NpgsqlDbType)">
  4100. <summary>
  4101. Initializes a new instance of <see cref="T:Npgsql.NpgsqlParameter`1" /> with a parameter name and type.
  4102. </summary>
  4103. </member>
  4104. <member name="M:Npgsql.NpgsqlParameter`1.#ctor(System.String,System.Data.DbType)">
  4105. <summary>
  4106. Initializes a new instance of <see cref="T:Npgsql.NpgsqlParameter`1" /> with a parameter name and type.
  4107. </summary>
  4108. </member>
  4109. <member name="T:Npgsql.NpgsqlRawCopyStream">
  4110. <summary>
  4111. Provides an API for a raw binary COPY operation, a high-performance data import/export mechanism to
  4112. a PostgreSQL table. Initiated by <see cref="M:Npgsql.NpgsqlConnection.BeginRawBinaryCopy(System.String)"/>
  4113. </summary>
  4114. <remarks>
  4115. See http://www.postgresql.org/docs/current/static/sql-copy.html.
  4116. </remarks>
  4117. </member>
  4118. <member name="F:Npgsql.NpgsqlRawCopyStream.BinarySignature">
  4119. <summary>
  4120. The copy binary format header signature
  4121. </summary>
  4122. </member>
  4123. <member name="M:Npgsql.NpgsqlRawCopyStream.Cancel">
  4124. <summary>
  4125. Cancels and terminates an ongoing operation. Any data already written will be discarded.
  4126. </summary>
  4127. </member>
  4128. <member name="T:Npgsql.NpgsqlCopyTextWriter">
  4129. <summary>
  4130. Writer for a text import, initiated by <see cref="M:Npgsql.NpgsqlConnection.BeginTextImport(System.String)"/>.
  4131. </summary>
  4132. <remarks>
  4133. See http://www.postgresql.org/docs/current/static/sql-copy.html.
  4134. </remarks>
  4135. </member>
  4136. <member name="M:Npgsql.NpgsqlCopyTextWriter.Cancel">
  4137. <summary>
  4138. Cancels and terminates an ongoing import. Any data already written will be discarded.
  4139. </summary>
  4140. </member>
  4141. <member name="T:Npgsql.NpgsqlCopyTextReader">
  4142. <summary>
  4143. Reader for a text export, initiated by <see cref="M:Npgsql.NpgsqlConnection.BeginTextExport(System.String)"/>.
  4144. </summary>
  4145. <remarks>
  4146. See http://www.postgresql.org/docs/current/static/sql-copy.html.
  4147. </remarks>
  4148. </member>
  4149. <member name="M:Npgsql.NpgsqlCopyTextReader.Cancel">
  4150. <summary>
  4151. Cancels and terminates an ongoing import.
  4152. </summary>
  4153. </member>
  4154. <member name="T:Npgsql.NpgsqlReadBuffer">
  4155. <summary>
  4156. A buffer used by Npgsql to read data from the socket efficiently.
  4157. Provides methods which decode different values types and tracks the current position.
  4158. </summary>
  4159. </member>
  4160. <member name="P:Npgsql.NpgsqlReadBuffer.Size">
  4161. <summary>
  4162. The total byte length of the buffer.
  4163. </summary>
  4164. </member>
  4165. <member name="F:Npgsql.NpgsqlReadBuffer.MinimumSize">
  4166. <summary>
  4167. The minimum buffer size possible.
  4168. </summary>
  4169. </member>
  4170. <member name="M:Npgsql.NpgsqlReadBuffer.Ensure(System.Int32,System.Boolean)">
  4171. <summary>
  4172. Ensures that <paramref name="count"/> bytes are available in the buffer, and if
  4173. not, reads from the socket until enough is available.
  4174. </summary>
  4175. </member>
  4176. <member name="M:Npgsql.NpgsqlReadBuffer.Skip(System.Int64)">
  4177. <summary>
  4178. Does not perform any I/O - assuming that the bytes to be skipped are in the memory buffer.
  4179. </summary>
  4180. <param name="len"></param>
  4181. </member>
  4182. <member name="M:Npgsql.NpgsqlReadBuffer.Skip(System.Int64,System.Boolean)">
  4183. <summary>
  4184. Skip a given number of bytes.
  4185. </summary>
  4186. </member>
  4187. <member name="M:Npgsql.NpgsqlReadBuffer.ReadNullTerminatedString">
  4188. <summary>
  4189. Seeks the first null terminator (\0) and returns the string up to it. The buffer must already
  4190. contain the entire string and its terminator.
  4191. </summary>
  4192. </member>
  4193. <member name="M:Npgsql.NpgsqlReadBuffer.ReadNullTerminatedString(System.Text.Encoding)">
  4194. <summary>
  4195. Seeks the first null terminator (\0) and returns the string up to it. The buffer must already
  4196. contain the entire string and its terminator.
  4197. </summary>
  4198. <param name="encoding">Decodes the messages with this encoding.</param>
  4199. </member>
  4200. <member name="T:Npgsql.NpgsqlSchema">
  4201. <summary>
  4202. Provides the underlying mechanism for reading schema information.
  4203. </summary>
  4204. </member>
  4205. <member name="M:Npgsql.NpgsqlSchema.GetMetaDataCollections">
  4206. <summary>
  4207. Returns the MetaDataCollections that lists all possible collections.
  4208. </summary>
  4209. <returns>The MetaDataCollections</returns>
  4210. </member>
  4211. <member name="M:Npgsql.NpgsqlSchema.GetRestrictions">
  4212. <summary>
  4213. Returns the Restrictions that contains the meaning and position of the values in the restrictions array.
  4214. </summary>
  4215. <returns>The Restrictions</returns>
  4216. </member>
  4217. <member name="M:Npgsql.NpgsqlSchema.GetDatabases(Npgsql.NpgsqlConnection,System.String[])">
  4218. <summary>
  4219. Returns the Databases that contains a list of all accessable databases.
  4220. </summary>
  4221. <param name="conn">The database connection on which to run the metadataquery.</param>
  4222. <param name="restrictions">The restrictions to filter the collection.</param>
  4223. <returns>The Databases</returns>
  4224. </member>
  4225. <member name="M:Npgsql.NpgsqlSchema.GetTables(Npgsql.NpgsqlConnection,System.String[])">
  4226. <summary>
  4227. Returns the Tables that contains table and view names and the database and schema they come from.
  4228. </summary>
  4229. <param name="conn">The database connection on which to run the metadataquery.</param>
  4230. <param name="restrictions">The restrictions to filter the collection.</param>
  4231. <returns>The Tables</returns>
  4232. </member>
  4233. <member name="M:Npgsql.NpgsqlSchema.GetColumns(Npgsql.NpgsqlConnection,System.String[])">
  4234. <summary>
  4235. Returns the Columns that contains information about columns in tables.
  4236. </summary>
  4237. <param name="conn">The database connection on which to run the metadataquery.</param>
  4238. <param name="restrictions">The restrictions to filter the collection.</param>
  4239. <returns>The Columns.</returns>
  4240. </member>
  4241. <member name="M:Npgsql.NpgsqlSchema.GetViews(Npgsql.NpgsqlConnection,System.String[])">
  4242. <summary>
  4243. Returns the Views that contains view names and the database and schema they come from.
  4244. </summary>
  4245. <param name="conn">The database connection on which to run the metadataquery.</param>
  4246. <param name="restrictions">The restrictions to filter the collection.</param>
  4247. <returns>The Views</returns>
  4248. </member>
  4249. <member name="M:Npgsql.NpgsqlSchema.GetUsers(Npgsql.NpgsqlConnection,System.String[])">
  4250. <summary>
  4251. Returns the Users containing user names and the sysid of those users.
  4252. </summary>
  4253. <param name="conn">The database connection on which to run the metadataquery.</param>
  4254. <param name="restrictions">The restrictions to filter the collection.</param>
  4255. <returns>The Users.</returns>
  4256. </member>
  4257. <member name="F:Npgsql.NpgsqlSchema.ReservedKeywords">
  4258. <summary>
  4259. List of keywords taken from PostgreSQL 9.0 reserved words documentation.
  4260. </summary>
  4261. </member>
  4262. <member name="T:Npgsql.NpgsqlSequentialDataReader">
  4263. <summary>
  4264. A sequential reader, which does not buffer rows in memory, and requires columns to be
  4265. read in-order only. Returned when <see cref="F:System.Data.CommandBehavior.SequentialAccess"/> is passed
  4266. to <see cref="M:Npgsql.NpgsqlCommand.ExecuteReader"/>.
  4267. </summary>
  4268. <remarks>
  4269. This reader is suitable in scenarios where a single row is very large, and holding
  4270. it in memory is undesirable.
  4271. </remarks>
  4272. </member>
  4273. <member name="F:Npgsql.NpgsqlSequentialDataReader._numColumns">
  4274. <summary>
  4275. The number of columns in the current row
  4276. </summary>
  4277. </member>
  4278. <member name="F:Npgsql.NpgsqlSequentialDataReader._column">
  4279. <summary>
  4280. The index of the column that we're on, i.e. that has already been parsed, is
  4281. is memory and can be retrieved. Initialized to -1
  4282. </summary>
  4283. </member>
  4284. <member name="M:Npgsql.NpgsqlSequentialDataReader.GetValue(System.Int32)">
  4285. <summary>
  4286. Gets the value of the specified column as an instance of <see cref="T:System.Object"/>.
  4287. </summary>
  4288. <param name="column">The zero-based column ordinal.</param>
  4289. <returns>The value of the specified column.</returns>
  4290. </member>
  4291. <member name="M:Npgsql.NpgsqlSequentialDataReader.GetProviderSpecificValue(System.Int32)">
  4292. <summary>
  4293. Gets the value of the specified column as an instance of <see cref="T:System.Object"/>.
  4294. </summary>
  4295. <param name="column">The zero-based column ordinal.</param>
  4296. <returns>The value of the specified column.</returns>
  4297. </member>
  4298. <member name="M:Npgsql.NpgsqlSequentialDataReader.SeekToColumn(System.Int32,System.Boolean)">
  4299. <summary>
  4300. Seeks to the given column. The 4-byte length is read and stored in <see cref="F:Npgsql.NpgsqlDataReader.ColumnLen"/>.
  4301. </summary>
  4302. </member>
  4303. <member name="M:Npgsql.NpgsqlSequentialDataReader.IsDBNull(System.Int32)">
  4304. <summary>
  4305. Gets a value that indicates whether the column contains nonexistent or missing values.
  4306. </summary>
  4307. <param name="ordinal">The zero-based column ordinal.</param>
  4308. <returns><b>true</b> if the specified column is equivalent to <see cref="T:System.DBNull"/>; otherwise <b>false</b>.</returns>
  4309. </member>
  4310. <member name="M:Npgsql.NpgsqlSequentialDataReader.IsDBNullAsync(System.Int32,System.Threading.CancellationToken)">
  4311. <summary>
  4312. An asynchronous version of <see cref="M:Npgsql.NpgsqlSequentialDataReader.IsDBNull(System.Int32)"/>, which gets a value that indicates whether the column contains non-existent or missing values.
  4313. The <paramref name="cancellationToken"/> parameter is currently ignored.
  4314. </summary>
  4315. <param name="ordinal">The zero-based column to be retrieved.</param>
  4316. <param name="cancellationToken">Currently ignored.</param>
  4317. <returns><b>true</b> if the specified column value is equivalent to <see cref="T:System.DBNull"/> otherwise <b>false</b>.</returns>
  4318. </member>
  4319. <member name="M:Npgsql.NpgsqlSequentialDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)">
  4320. <summary>
  4321. 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.
  4322. </summary>
  4323. <param name="ordinal">The zero-based column ordinal.</param>
  4324. <param name="dataOffset">The index within the row from which to begin the read operation.</param>
  4325. <param name="buffer">The buffer into which to copy the data.</param>
  4326. <param name="bufferOffset">The index with the buffer to which the data will be copied.</param>
  4327. <param name="length">The maximum number of characters to read.</param>
  4328. <returns>The actual number of bytes read.</returns>
  4329. </member>
  4330. <member name="T:Npgsql.NpgsqlStatement">
  4331. <summary>
  4332. Represents a single SQL statement within Npgsql.
  4333. Instances aren't constructed directly; users should construct an <see cref="T:Npgsql.NpgsqlCommand"/>
  4334. object and populate its <see cref="P:Npgsql.NpgsqlCommand.CommandText"/> property as in standard ADO.NET.
  4335. Npgsql will analyze that property and constructed instances of <see cref="T:Npgsql.NpgsqlStatement"/>
  4336. internally.
  4337. Users can retrieve instances from <see cref="P:Npgsql.NpgsqlDataReader.Statements"/>
  4338. and access information about statement execution (e.g. affected rows).
  4339. </summary>
  4340. </member>
  4341. <member name="P:Npgsql.NpgsqlStatement.SQL">
  4342. <summary>
  4343. The SQL text of the statement.
  4344. </summary>
  4345. </member>
  4346. <member name="P:Npgsql.NpgsqlStatement.StatementType">
  4347. <summary>
  4348. Specifies the type of query, e.g. SELECT.
  4349. </summary>
  4350. </member>
  4351. <member name="P:Npgsql.NpgsqlStatement.Rows">
  4352. <summary>
  4353. The number of rows affected or retrieved.
  4354. </summary>
  4355. <remarks>
  4356. See the command tag in the CommandComplete message,
  4357. http://www.postgresql.org/docs/current/static/protocol-message-formats.html
  4358. </remarks>
  4359. </member>
  4360. <member name="P:Npgsql.NpgsqlStatement.OID">
  4361. <summary>
  4362. For an INSERT, the object ID of the inserted row if <see cref="P:Npgsql.NpgsqlStatement.Rows"/> is 1 and
  4363. the target table has OIDs; otherwise 0.
  4364. </summary>
  4365. </member>
  4366. <member name="P:Npgsql.NpgsqlStatement.InputParameters">
  4367. <summary>
  4368. The input parameters sent with this statement.
  4369. </summary>
  4370. </member>
  4371. <member name="P:Npgsql.NpgsqlStatement.Description">
  4372. <summary>
  4373. The RowDescription message for this query. If null, the query does not return rows (e.g. INSERT)
  4374. </summary>
  4375. </member>
  4376. <member name="P:Npgsql.NpgsqlStatement.PreparedStatement">
  4377. <summary>
  4378. If this statement has been automatically prepared, references the <see cref="P:Npgsql.NpgsqlStatement.PreparedStatement"/>.
  4379. Null otherwise.
  4380. </summary>
  4381. </member>
  4382. <member name="P:Npgsql.NpgsqlStatement.StatementName">
  4383. <summary>
  4384. Holds the server-side (prepared) statement name. Empty string for non-prepared statements.
  4385. </summary>
  4386. </member>
  4387. <member name="P:Npgsql.NpgsqlStatement.IsPrepared">
  4388. <summary>
  4389. Whether this statement has already been prepared (including automatic preparation).
  4390. </summary>
  4391. </member>
  4392. <member name="M:Npgsql.NpgsqlStatement.ToString">
  4393. <summary>
  4394. Returns the SQL text of the statement.
  4395. </summary>
  4396. </member>
  4397. <member name="T:Npgsql.NpgsqlTransaction">
  4398. <summary>
  4399. Represents a transaction to be made in a PostgreSQL database. This class cannot be inherited.
  4400. </summary>
  4401. </member>
  4402. <member name="P:Npgsql.NpgsqlTransaction.Connection">
  4403. <summary>
  4404. Specifies the <see cref="T:Npgsql.NpgsqlConnection"/> object associated with the transaction.
  4405. </summary>
  4406. <value>The <see cref="T:Npgsql.NpgsqlConnection"/> object associated with the transaction.</value>
  4407. </member>
  4408. <member name="P:Npgsql.NpgsqlTransaction.IsCompleted">
  4409. <summary>
  4410. Specifies the completion state of the transaction.
  4411. </summary>
  4412. <value>The completion state of the transaction.</value>
  4413. </member>
  4414. <member name="P:Npgsql.NpgsqlTransaction.DbConnection">
  4415. <summary>
  4416. Specifies the <see cref="T:Npgsql.NpgsqlConnection"/> object associated with the transaction.
  4417. </summary>
  4418. <value>The <see cref="T:Npgsql.NpgsqlConnection"/> object associated with the transaction.</value>
  4419. </member>
  4420. <member name="P:Npgsql.NpgsqlTransaction.IsolationLevel">
  4421. <summary>
  4422. Specifies the <see cref="T:System.Data.IsolationLevel">IsolationLevel</see> for this transaction.
  4423. </summary>
  4424. <value>The <see cref="T:System.Data.IsolationLevel">IsolationLevel</see> for this transaction.
  4425. The default is <b>ReadCommitted</b>.</value>
  4426. </member>
  4427. <member name="M:Npgsql.NpgsqlTransaction.Commit">
  4428. <summary>
  4429. Commits the database transaction.
  4430. </summary>
  4431. </member>
  4432. <member name="M:Npgsql.NpgsqlTransaction.CommitAsync(System.Threading.CancellationToken)">
  4433. <summary>
  4434. Commits the database transaction.
  4435. </summary>
  4436. </member>
  4437. <member name="M:Npgsql.NpgsqlTransaction.CommitAsync">
  4438. <summary>
  4439. Commits the database transaction.
  4440. </summary>
  4441. </member>
  4442. <member name="M:Npgsql.NpgsqlTransaction.Rollback">
  4443. <summary>
  4444. Rolls back a transaction from a pending state.
  4445. </summary>
  4446. </member>
  4447. <member name="M:Npgsql.NpgsqlTransaction.RollbackAsync(System.Threading.CancellationToken)">
  4448. <summary>
  4449. Rolls back a transaction from a pending state.
  4450. </summary>
  4451. </member>
  4452. <member name="M:Npgsql.NpgsqlTransaction.RollbackAsync">
  4453. <summary>
  4454. Rolls back a transaction from a pending state.
  4455. </summary>
  4456. </member>
  4457. <member name="M:Npgsql.NpgsqlTransaction.Save(System.String)">
  4458. <summary>
  4459. Creates a transaction save point.
  4460. </summary>
  4461. </member>
  4462. <member name="M:Npgsql.NpgsqlTransaction.Rollback(System.String)">
  4463. <summary>
  4464. Rolls back a transaction from a pending savepoint state.
  4465. </summary>
  4466. </member>
  4467. <member name="M:Npgsql.NpgsqlTransaction.Release(System.String)">
  4468. <summary>
  4469. Rolls back a transaction from a pending savepoint state.
  4470. </summary>
  4471. </member>
  4472. <member name="M:Npgsql.NpgsqlTransaction.Dispose(System.Boolean)">
  4473. <summary>
  4474. Disposes the transaction, rolling it back if it is still pending.
  4475. </summary>
  4476. </member>
  4477. <member name="T:Npgsql.NpgsqlWriteBuffer">
  4478. <summary>
  4479. A buffer used by Npgsql to write data to the socket efficiently.
  4480. Provides methods which encode different values types and tracks the current position.
  4481. </summary>
  4482. </member>
  4483. <member name="P:Npgsql.NpgsqlWriteBuffer.Size">
  4484. <summary>
  4485. The total byte length of the buffer.
  4486. </summary>
  4487. </member>
  4488. <member name="F:Npgsql.NpgsqlWriteBuffer.MinimumSize">
  4489. <summary>
  4490. The minimum buffer size possible.
  4491. </summary>
  4492. </member>
  4493. <member name="M:Npgsql.NpgsqlWriteBuffer.GetContents">
  4494. <summary>
  4495. Returns all contents currently written to the buffer (but not flushed).
  4496. Useful for pregenerating messages.
  4497. </summary>
  4498. </member>
  4499. <member name="T:Npgsql.PgPassFile">
  4500. <summary>
  4501. Represents a .pgpass file, which contains passwords for noninteractive connections
  4502. </summary>
  4503. </member>
  4504. <member name="P:Npgsql.PgPassFile.FileName">
  4505. <summary>
  4506. File name being parsed for credentials
  4507. </summary>
  4508. </member>
  4509. <member name="M:Npgsql.PgPassFile.#ctor(System.String)">
  4510. <summary>
  4511. Initializes a new instance of the <see cref="T:Npgsql.PgPassFile"/> class
  4512. </summary>
  4513. <param name="fileName"></param>
  4514. </member>
  4515. <member name="P:Npgsql.PgPassFile.Entries">
  4516. <summary>
  4517. Parses file content and gets all credentials from the file
  4518. </summary>
  4519. <returns><see cref="T:System.Collections.Generic.IEnumerable`1"/> corresponding to all lines in the .pgpass file</returns>
  4520. </member>
  4521. <member name="M:Npgsql.PgPassFile.GetFirstMatchingEntry(System.String,System.Nullable{System.Int32},System.String,System.String)">
  4522. <summary>
  4523. Searches queries loaded from .PGPASS file to find first entry matching the provided parameters.
  4524. </summary>
  4525. <param name="host">Hostname to query. Use null to match any.</param>
  4526. <param name="port">Port to query. Use null to match any.</param>
  4527. <param name="database">Database to query. Use null to match any.</param>
  4528. <param name="username">User name to query. Use null to match any.</param>
  4529. <returns>Matching <see cref="T:Npgsql.PgPassFile.Entry"/> if match was found. Otherwise, returns null.</returns>
  4530. </member>
  4531. <member name="M:Npgsql.PgPassFile.GetSystemPgPassFilePath">
  4532. <summary>
  4533. Retrieves the full system path to the pgpass file. Does not check whether the
  4534. file actually exist.
  4535. </summary>
  4536. <remarks>
  4537. See https://www.postgresql.org/docs/current/static/libpq-pgpass.html
  4538. </remarks>
  4539. <returns>Path to the pgpass file</returns>
  4540. </member>
  4541. <member name="T:Npgsql.PgPassFile.Entry">
  4542. <summary>
  4543. Represents a hostname, port, database, username, and password combination that has been retrieved from a .pgpass file
  4544. </summary>
  4545. </member>
  4546. <member name="P:Npgsql.PgPassFile.Entry.Host">
  4547. <summary>
  4548. Hostname parsed from the .pgpass file
  4549. </summary>
  4550. </member>
  4551. <member name="P:Npgsql.PgPassFile.Entry.Port">
  4552. <summary>
  4553. Port parsed from the .pgpass file
  4554. </summary>
  4555. </member>
  4556. <member name="P:Npgsql.PgPassFile.Entry.Database">
  4557. <summary>
  4558. Database parsed from the .pgpass file
  4559. </summary>
  4560. </member>
  4561. <member name="P:Npgsql.PgPassFile.Entry.Username">
  4562. <summary>
  4563. User name parsed from the .pgpass file
  4564. </summary>
  4565. </member>
  4566. <member name="P:Npgsql.PgPassFile.Entry.Password">
  4567. <summary>
  4568. Password parsed from the .pgpass file
  4569. </summary>
  4570. </member>
  4571. <member name="M:Npgsql.PgPassFile.Entry.#ctor(System.String,System.Nullable{System.Int32},System.String,System.String,System.String)">
  4572. <summary>
  4573. This class represents an entry from the .pgpass file
  4574. </summary>
  4575. <param name="host">Hostname parsed from the .pgpass file</param>
  4576. <param name="port">Port parsed from the .pgpass file</param>
  4577. <param name="database">Database parsed from the .pgpass file</param>
  4578. <param name="username">User name parsed from the .pgpass file</param>
  4579. <param name="password">Password parsed from the .pgpass file</param>
  4580. </member>
  4581. <member name="M:Npgsql.PgPassFile.Entry.Parse(System.String)">
  4582. <summary>
  4583. 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 \.
  4584. </summary>
  4585. <param name="serializedEntry">string for the entry from the pgpass file</param>
  4586. <returns>New instance of <see cref="T:Npgsql.PgPassFile.Entry"/> for the string</returns>
  4587. <exception cref="T:System.FormatException">Entry is not formatted as hostname:port:database:username:password or non-wildcard port is not a number</exception>
  4588. </member>
  4589. <member name="M:Npgsql.PgPassFile.Entry.IsMatch(System.String,System.Nullable{System.Int32},System.String,System.String)">
  4590. <summary>
  4591. Checks whether this <see cref="T:Npgsql.PgPassFile.Entry"/> matches the parameters supplied
  4592. </summary>
  4593. <param name="host">Hostname to check against this entry</param>
  4594. <param name="port">Port to check against this entry</param>
  4595. <param name="database">Database to check against this entry</param>
  4596. <param name="username">Username to check against this entry</param>
  4597. <returns>True if the entry is a match. False otherwise.</returns>
  4598. </member>
  4599. <member name="M:Npgsql.PgPassFile.Entry.AreValuesMatched(System.String,System.String)">
  4600. <summary>
  4601. Checks if 2 strings are a match for a <see cref="T:Npgsql.PgPassFile.Entry"/> considering that either value can be a wildcard (*)
  4602. </summary>
  4603. <param name="query">Value being searched</param>
  4604. <param name="actual">Value from the PGPASS entry</param>
  4605. <returns>True if the values are a match. False otherwise.</returns>
  4606. </member>
  4607. <member name="T:Npgsql.NpgsqlTimeout">
  4608. <summary>
  4609. Represents a timeout that will expire at some point.
  4610. </summary>
  4611. </member>
  4612. <member name="T:Npgsql.PoolManager">
  4613. <summary>
  4614. Provides lookup for a pool based on a connection string.
  4615. </summary>
  4616. <remarks>
  4617. <see cref="M:Npgsql.PoolManager.TryGetValue(System.String,Npgsql.ConnectorPool@)"/> is lock-free, to avoid contention, but the same isn't
  4618. true of <see cref="M:Npgsql.PoolManager.GetOrAdd(System.String,Npgsql.ConnectorPool)"/>, which acquires a lock. The calling code always tries
  4619. <see cref="M:Npgsql.PoolManager.TryGetValue(System.String,Npgsql.ConnectorPool@)"/> before trying to <see cref="M:Npgsql.PoolManager.GetOrAdd(System.String,Npgsql.ConnectorPool)"/>.
  4620. </remarks>
  4621. </member>
  4622. <member name="M:Npgsql.PoolManager.Reset">
  4623. <summary>
  4624. Resets the pool manager to its initial state, for test purposes only.
  4625. Assumes that no other threads are accessing the pool.
  4626. </summary>
  4627. </member>
  4628. <member name="T:Npgsql.PostgresDatabaseInfoFactory">
  4629. <summary>
  4630. The default implementation of <see cref="T:Npgsql.INpgsqlDatabaseInfoFactory"/>, for standard PostgreSQL databases..
  4631. </summary>
  4632. </member>
  4633. <member name="M:Npgsql.PostgresDatabaseInfoFactory.Load(Npgsql.NpgsqlConnection,Npgsql.NpgsqlTimeout,System.Boolean)">
  4634. <inheritdoc />
  4635. </member>
  4636. <member name="T:Npgsql.PostgresDatabaseInfo">
  4637. <summary>
  4638. The default implementation of NpgsqlDatabase, for standard PostgreSQL databases.
  4639. </summary>
  4640. </member>
  4641. <member name="F:Npgsql.PostgresDatabaseInfo.Log">
  4642. <summary>
  4643. The Npgsql logger instance.
  4644. </summary>
  4645. </member>
  4646. <member name="F:Npgsql.PostgresDatabaseInfo._types">
  4647. <summary>
  4648. The PostgreSQL types detected in the database.
  4649. </summary>
  4650. </member>
  4651. <member name="M:Npgsql.PostgresDatabaseInfo.GetTypes">
  4652. <inheritdoc />
  4653. </member>
  4654. <member name="P:Npgsql.PostgresDatabaseInfo.IsRedshift">
  4655. <summary>
  4656. True if the backend is Amazon Redshift; otherwise, false.
  4657. </summary>
  4658. </member>
  4659. <member name="P:Npgsql.PostgresDatabaseInfo.SupportsUnlisten">
  4660. <inheritdoc />
  4661. </member>
  4662. <member name="P:Npgsql.PostgresDatabaseInfo.HasEnumSortOrder">
  4663. <summary>
  4664. True if the 'pg_enum' table includes the 'enumsortorder' column; otherwise, false.
  4665. </summary>
  4666. </member>
  4667. <member name="M:Npgsql.PostgresDatabaseInfo.LoadPostgresInfo(Npgsql.NpgsqlConnection,Npgsql.NpgsqlTimeout,System.Boolean)">
  4668. <summary>
  4669. Loads database information from the PostgreSQL database specified by <paramref name="conn"/>.
  4670. </summary>
  4671. <param name="conn">The database connection.</param>
  4672. <param name="timeout">The timeout while loading types from the backend.</param>
  4673. <param name="async">True to load types asynchronously.</param>
  4674. <returns>
  4675. A task representing the asynchronous operation.
  4676. </returns>
  4677. </member>
  4678. <member name="M:Npgsql.PostgresDatabaseInfo.GenerateTypesQuery(System.Boolean,System.Boolean,System.Boolean,System.Boolean)">
  4679. <summary>
  4680. Generates a raw SQL query string to select type information.
  4681. </summary>
  4682. <param name="withRange">True to load range types.</param>
  4683. <param name="withEnum">True to load enum types.</param>
  4684. <param name="withEnumSortOrder"></param>
  4685. <param name="loadTableComposites">True to load table composites.</param>
  4686. <returns>
  4687. A raw SQL query string that selects type information.
  4688. </returns>
  4689. <remarks>
  4690. Select all types (base, array which is also base, enum, range, composite).
  4691. Note that arrays are distinguished from primitive types through them having typreceive=array_recv.
  4692. Order by primitives first, container later.
  4693. For arrays and ranges, join in the element OID and type (to filter out arrays of unhandled
  4694. types).
  4695. </remarks>
  4696. </member>
  4697. <member name="M:Npgsql.PostgresDatabaseInfo.LoadBackendTypes(Npgsql.NpgsqlConnection,Npgsql.NpgsqlTimeout,System.Boolean)">
  4698. <summary>
  4699. Loads type information from the backend specified by <paramref name="conn"/>.
  4700. </summary>
  4701. <param name="conn">The database connection.</param>
  4702. <param name="timeout">The timeout while loading types from the backend.</param>
  4703. <param name="async">True to load types asynchronously.</param>
  4704. <returns>
  4705. A collection of types loaded from the backend.
  4706. </returns>
  4707. <exception cref="T:System.TimeoutException" />
  4708. <exception cref="T:System.ArgumentOutOfRangeException">Unknown typtype for type '{internalName}' in pg_type: {typeChar}.</exception>
  4709. </member>
  4710. <member name="M:Npgsql.PostgresDatabaseInfo.LoadCompositeFields(System.Data.Common.DbDataReader,System.Collections.Generic.Dictionary{System.UInt32,Npgsql.PostgresTypes.PostgresType})">
  4711. <summary>
  4712. Loads composite fields for the composite type specified by the OID.
  4713. </summary>
  4714. <param name="reader">The reader from which to read composite fields.</param>
  4715. <param name="byOID">The OID of the composite type for which fields are read.</param>
  4716. </member>
  4717. <member name="M:Npgsql.PostgresDatabaseInfo.LoadEnumLabels(System.Data.Common.DbDataReader,System.Collections.Generic.Dictionary{System.UInt32,Npgsql.PostgresTypes.PostgresType})">
  4718. <summary>
  4719. Loads enum labels for the enum type specified by the OID.
  4720. </summary>
  4721. <param name="reader">The reader from which to read enum labels.</param>
  4722. <param name="byOID">The OID of the enum type for which labels are read.</param>
  4723. </member>
  4724. <member name="T:Npgsql.PostgresException">
  4725. <summary>
  4726. The exception that is thrown when the PostgreSQL backend reports errors (e.g. query
  4727. SQL issues, constraint violations).
  4728. </summary>
  4729. <remarks>
  4730. This exception only corresponds to a PostgreSQL-delivered error.
  4731. Other errors (e.g. network issues) will be raised via <see cref="T:Npgsql.NpgsqlException"/>,
  4732. and purely Npgsql-related issues which aren't related to the server will be raised
  4733. via the standard CLR exceptions (e.g. ArgumentException).
  4734. See http://www.postgresql.org/docs/current/static/errcodes-appendix.html,
  4735. http://www.postgresql.org/docs/current/static/protocol-error-fields.html
  4736. </remarks>
  4737. </member>
  4738. <member name="P:Npgsql.PostgresException.Severity">
  4739. <summary>
  4740. Severity of the error or notice.
  4741. Always present.
  4742. </summary>
  4743. </member>
  4744. <member name="P:Npgsql.PostgresException.SqlState">
  4745. <summary>
  4746. The SQLSTATE code for the error.
  4747. </summary>
  4748. <remarks>
  4749. Always present.
  4750. See http://www.postgresql.org/docs/current/static/errcodes-appendix.html
  4751. </remarks>
  4752. </member>
  4753. <member name="P:Npgsql.PostgresException.Code">
  4754. <summary>
  4755. The SQLSTATE code for the error.
  4756. </summary>
  4757. <remarks>
  4758. Always present.
  4759. See http://www.postgresql.org/docs/current/static/errcodes-appendix.html
  4760. </remarks>
  4761. </member>
  4762. <member name="P:Npgsql.PostgresException.MessageText">
  4763. <summary>
  4764. The primary human-readable error message. This should be accurate but terse.
  4765. </summary>
  4766. <remarks>
  4767. Always present.
  4768. </remarks>
  4769. </member>
  4770. <member name="P:Npgsql.PostgresException.Detail">
  4771. <summary>
  4772. An optional secondary error message carrying more detail about the problem.
  4773. May run to multiple lines.
  4774. </summary>
  4775. </member>
  4776. <member name="P:Npgsql.PostgresException.Hint">
  4777. <summary>
  4778. An optional suggestion what to do about the problem.
  4779. This is intended to differ from Detail in that it offers advice (potentially inappropriate) rather than hard facts.
  4780. May run to multiple lines.
  4781. </summary>
  4782. </member>
  4783. <member name="P:Npgsql.PostgresException.Position">
  4784. <summary>
  4785. The field value is a decimal ASCII integer, indicating an error cursor position as an index into the original query string.
  4786. The first character has index 1, and positions are measured in characters not bytes.
  4787. 0 means not provided.
  4788. </summary>
  4789. </member>
  4790. <member name="P:Npgsql.PostgresException.InternalPosition">
  4791. <summary>
  4792. 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.
  4793. The <see cref="P:Npgsql.PostgresException.InternalQuery" /> field will always appear when this field appears.
  4794. 0 means not provided.
  4795. </summary>
  4796. </member>
  4797. <member name="P:Npgsql.PostgresException.InternalQuery">
  4798. <summary>
  4799. The text of a failed internally-generated command.
  4800. This could be, for example, a SQL query issued by a PL/pgSQL function.
  4801. </summary>
  4802. </member>
  4803. <member name="P:Npgsql.PostgresException.Where">
  4804. <summary>
  4805. An indication of the context in which the error occurred.
  4806. Presently this includes a call stack traceback of active PL functions.
  4807. The trace is one entry per line, most recent first.
  4808. </summary>
  4809. </member>
  4810. <member name="P:Npgsql.PostgresException.SchemaName">
  4811. <summary>
  4812. If the error was associated with a specific database object, the name of the schema containing that object, if any.
  4813. </summary>
  4814. <remarks>PostgreSQL 9.3 and up.</remarks>
  4815. </member>
  4816. <member name="P:Npgsql.PostgresException.TableName">
  4817. <summary>
  4818. Table name: if the error was associated with a specific table, the name of the table.
  4819. (Refer to the schema name field for the name of the table's schema.)
  4820. </summary>
  4821. <remarks>PostgreSQL 9.3 and up.</remarks>
  4822. </member>
  4823. <member name="P:Npgsql.PostgresException.ColumnName">
  4824. <summary>
  4825. If the error was associated with a specific table column, the name of the column.
  4826. (Refer to the schema and table name fields to identify the table.)
  4827. </summary>
  4828. <remarks>PostgreSQL 9.3 and up.</remarks>
  4829. </member>
  4830. <member name="P:Npgsql.PostgresException.DataTypeName">
  4831. <summary>
  4832. If the error was associated with a specific data type, the name of the data type.
  4833. (Refer to the schema name field for the name of the data type's schema.)
  4834. </summary>
  4835. <remarks>PostgreSQL 9.3 and up.</remarks>
  4836. </member>
  4837. <member name="P:Npgsql.PostgresException.ConstraintName">
  4838. <summary>
  4839. If the error was associated with a specific constraint, the name of the constraint.
  4840. Refer to fields listed above for the associated table or domain.
  4841. (For this purpose, indexes are treated as constraints, even if they weren't created with constraint syntax.)
  4842. </summary>
  4843. <remarks>PostgreSQL 9.3 and up.</remarks>
  4844. </member>
  4845. <member name="P:Npgsql.PostgresException.File">
  4846. <summary>
  4847. The file name of the source-code location where the error was reported.
  4848. </summary>
  4849. <remarks>PostgreSQL 9.3 and up.</remarks>
  4850. </member>
  4851. <member name="P:Npgsql.PostgresException.Line">
  4852. <summary>
  4853. The line number of the source-code location where the error was reported.
  4854. </summary>
  4855. </member>
  4856. <member name="P:Npgsql.PostgresException.Routine">
  4857. <summary>
  4858. The name of the source-code routine reporting the error.
  4859. </summary>
  4860. </member>
  4861. <member name="M:Npgsql.PostgresException.#ctor">
  4862. <summary>
  4863. Creates a new instance.
  4864. </summary>
  4865. </member>
  4866. <member name="P:Npgsql.PostgresException.Message">
  4867. <summary>
  4868. Gets a the PostgreSQL error message and code.
  4869. </summary>
  4870. </member>
  4871. <member name="P:Npgsql.PostgresException.IsTransient">
  4872. <summary>
  4873. Specifies whether the exception is considered transient, that is, whether retrying to operation could
  4874. succeed (e.g. a network error). Check <see cref="P:Npgsql.PostgresException.SqlState"/>.
  4875. </summary>
  4876. </member>
  4877. <member name="P:Npgsql.PostgresException.Statement">
  4878. <summary>
  4879. Returns the statement which triggered this exception.
  4880. </summary>
  4881. </member>
  4882. <member name="P:Npgsql.PostgresException.Data">
  4883. <summary>
  4884. Gets a collection of key/value pairs that provide additional PostgreSQL fields about the exception.
  4885. </summary>
  4886. </member>
  4887. <member name="M:Npgsql.PostgresException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  4888. <summary>
  4889. Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with the data needed to serialize the target object.
  4890. </summary>
  4891. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param>
  4892. <param name="context">The destination (see <see cref="T:System.Runtime.Serialization.StreamingContext"/>) for this serialization.</param>
  4893. </member>
  4894. <member name="T:Npgsql.PostgresNotice">
  4895. <summary>
  4896. PostgreSQL notices are non-critical messages generated by PostgreSQL, either as a result of a user query
  4897. (e.g. as a warning or informational notice), or due to outside activity (e.g. if the database administrator
  4898. initiates a "fast" database shutdown).
  4899. </summary>
  4900. <remarks>
  4901. http://www.postgresql.org/docs/current/static/protocol-flow.html#PROTOCOL-ASYNC
  4902. </remarks>
  4903. </member>
  4904. <member name="P:Npgsql.PostgresNotice.Severity">
  4905. <summary>
  4906. Severity of the error or notice.
  4907. Always present.
  4908. </summary>
  4909. </member>
  4910. <member name="P:Npgsql.PostgresNotice.SqlState">
  4911. <summary>
  4912. The SQLSTATE code for the error.
  4913. </summary>
  4914. <remarks>
  4915. Always present.
  4916. See http://www.postgresql.org/docs/current/static/errcodes-appendix.html
  4917. </remarks>
  4918. </member>
  4919. <member name="P:Npgsql.PostgresNotice.Code">
  4920. <summary>
  4921. The SQLSTATE code for the error.
  4922. </summary>
  4923. <remarks>
  4924. Always present.
  4925. See http://www.postgresql.org/docs/current/static/errcodes-appendix.html
  4926. </remarks>
  4927. </member>
  4928. <member name="P:Npgsql.PostgresNotice.MessageText">
  4929. <summary>
  4930. The primary human-readable error message. This should be accurate but terse.
  4931. </summary>
  4932. <remarks>
  4933. Always present.
  4934. </remarks>
  4935. </member>
  4936. <member name="P:Npgsql.PostgresNotice.Detail">
  4937. <summary>
  4938. An optional secondary error message carrying more detail about the problem.
  4939. May run to multiple lines.
  4940. </summary>
  4941. </member>
  4942. <member name="P:Npgsql.PostgresNotice.Hint">
  4943. <summary>
  4944. An optional suggestion what to do about the problem.
  4945. This is intended to differ from Detail in that it offers advice (potentially inappropriate) rather than hard facts.
  4946. May run to multiple lines.
  4947. </summary>
  4948. </member>
  4949. <member name="P:Npgsql.PostgresNotice.Position">
  4950. <summary>
  4951. The field value is a decimal ASCII integer, indicating an error cursor position as an index into the original query string.
  4952. The first character has index 1, and positions are measured in characters not bytes.
  4953. 0 means not provided.
  4954. </summary>
  4955. </member>
  4956. <member name="P:Npgsql.PostgresNotice.InternalPosition">
  4957. <summary>
  4958. 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.
  4959. The <see cref="P:Npgsql.PostgresNotice.InternalQuery" /> field will always appear when this field appears.
  4960. 0 means not provided.
  4961. </summary>
  4962. </member>
  4963. <member name="P:Npgsql.PostgresNotice.InternalQuery">
  4964. <summary>
  4965. The text of a failed internally-generated command.
  4966. This could be, for example, a SQL query issued by a PL/pgSQL function.
  4967. </summary>
  4968. </member>
  4969. <member name="P:Npgsql.PostgresNotice.Where">
  4970. <summary>
  4971. An indication of the context in which the error occurred.
  4972. Presently this includes a call stack traceback of active PL functions.
  4973. The trace is one entry per line, most recent first.
  4974. </summary>
  4975. </member>
  4976. <member name="P:Npgsql.PostgresNotice.SchemaName">
  4977. <summary>
  4978. If the error was associated with a specific database object, the name of the schema containing that object, if any.
  4979. </summary>
  4980. <remarks>PostgreSQL 9.3 and up.</remarks>
  4981. </member>
  4982. <member name="P:Npgsql.PostgresNotice.TableName">
  4983. <summary>
  4984. Table name: if the error was associated with a specific table, the name of the table.
  4985. (Refer to the schema name field for the name of the table's schema.)
  4986. </summary>
  4987. <remarks>PostgreSQL 9.3 and up.</remarks>
  4988. </member>
  4989. <member name="P:Npgsql.PostgresNotice.ColumnName">
  4990. <summary>
  4991. If the error was associated with a specific table column, the name of the column.
  4992. (Refer to the schema and table name fields to identify the table.)
  4993. </summary>
  4994. <remarks>PostgreSQL 9.3 and up.</remarks>
  4995. </member>
  4996. <member name="P:Npgsql.PostgresNotice.DataTypeName">
  4997. <summary>
  4998. If the error was associated with a specific data type, the name of the data type.
  4999. (Refer to the schema name field for the name of the data type's schema.)
  5000. </summary>
  5001. <remarks>PostgreSQL 9.3 and up.</remarks>
  5002. </member>
  5003. <member name="P:Npgsql.PostgresNotice.ConstraintName">
  5004. <summary>
  5005. If the error was associated with a specific constraint, the name of the constraint.
  5006. Refer to fields listed above for the associated table or domain.
  5007. (For this purpose, indexes are treated as constraints, even if they weren't created with constraint syntax.)
  5008. </summary>
  5009. <remarks>PostgreSQL 9.3 and up.</remarks>
  5010. </member>
  5011. <member name="P:Npgsql.PostgresNotice.File">
  5012. <summary>
  5013. The file name of the source-code location where the error was reported.
  5014. </summary>
  5015. <remarks>PostgreSQL 9.3 and up.</remarks>
  5016. </member>
  5017. <member name="P:Npgsql.PostgresNotice.Line">
  5018. <summary>
  5019. The line number of the source-code location where the error was reported.
  5020. </summary>
  5021. </member>
  5022. <member name="P:Npgsql.PostgresNotice.Routine">
  5023. <summary>
  5024. The name of the source-code routine reporting the error.
  5025. </summary>
  5026. </member>
  5027. <member name="M:Npgsql.PostgresNotice.#ctor">
  5028. <summary>
  5029. Creates a new instance.
  5030. </summary>
  5031. </member>
  5032. <member name="T:Npgsql.NpgsqlNoticeEventArgs">
  5033. <summary>
  5034. Provides data for a PostgreSQL notice event.
  5035. </summary>
  5036. </member>
  5037. <member name="P:Npgsql.NpgsqlNoticeEventArgs.Notice">
  5038. <summary>
  5039. The Notice that was sent from the database.
  5040. </summary>
  5041. </member>
  5042. <member name="T:Npgsql.PostgresTypes.PostgresArrayType">
  5043. <summary>
  5044. Represents a PostgreSQL array data type, which can hold several multiple values in a single column.
  5045. </summary>
  5046. <remarks>
  5047. See https://www.postgresql.org/docs/current/static/arrays.html.
  5048. </remarks>
  5049. </member>
  5050. <member name="P:Npgsql.PostgresTypes.PostgresArrayType.Element">
  5051. <summary>
  5052. The PostgreSQL data type of the element contained within this array.
  5053. </summary>
  5054. </member>
  5055. <member name="M:Npgsql.PostgresTypes.PostgresArrayType.#ctor(System.String,System.String,System.UInt32,Npgsql.PostgresTypes.PostgresType)">
  5056. <summary>
  5057. Constructs a representation of a PostgreSQL array data type.
  5058. </summary>
  5059. </member>
  5060. <member name="M:Npgsql.PostgresTypes.PostgresArrayType.GetPartialNameWithFacets(System.Int32)">
  5061. <inheritdoc/>
  5062. </member>
  5063. <member name="T:Npgsql.PostgresTypes.PostgresBaseType">
  5064. <summary>
  5065. Represents a PostgreSQL base data type, which is a simple scalar value.
  5066. </summary>
  5067. </member>
  5068. <member name="M:Npgsql.PostgresTypes.PostgresBaseType.#ctor(System.String,System.String,System.UInt32)">
  5069. <inheritdoc/>
  5070. </member>
  5071. <member name="M:Npgsql.PostgresTypes.PostgresBaseType.GetPartialNameWithFacets(System.Int32)">
  5072. <inheritdoc/>
  5073. </member>
  5074. <member name="T:Npgsql.PostgresTypes.PostgresCompositeType">
  5075. <summary>
  5076. Represents a PostgreSQL composite data type, which can hold multiple fields of varying types in a single column.
  5077. </summary>
  5078. <remarks>
  5079. See https://www.postgresql.org/docs/current/static/rowtypes.html.
  5080. </remarks>
  5081. </member>
  5082. <member name="P:Npgsql.PostgresTypes.PostgresCompositeType.Fields">
  5083. <summary>
  5084. Holds the name and types for all fields.
  5085. </summary>
  5086. </member>
  5087. <member name="M:Npgsql.PostgresTypes.PostgresCompositeType.#ctor(System.String,System.String,System.UInt32)">
  5088. <summary>
  5089. Constructs a representation of a PostgreSQL array data type.
  5090. </summary>
  5091. </member>
  5092. <member name="T:Npgsql.PostgresTypes.PostgresCompositeType.Field">
  5093. <summary>
  5094. Represents a field in a PostgreSQL composite data type.
  5095. </summary>
  5096. </member>
  5097. <member name="P:Npgsql.PostgresTypes.PostgresCompositeType.Field.Name">
  5098. <summary>
  5099. The name of the composite field.
  5100. </summary>
  5101. </member>
  5102. <member name="P:Npgsql.PostgresTypes.PostgresCompositeType.Field.Type">
  5103. <summary>
  5104. The type of the composite field.
  5105. </summary>
  5106. </member>
  5107. <member name="M:Npgsql.PostgresTypes.PostgresCompositeType.Field.ToString">
  5108. <inheritdoc />
  5109. </member>
  5110. <member name="T:Npgsql.PostgresTypes.PostgresDomainType">
  5111. <summary>
  5112. Represents a PostgreSQL domain type.
  5113. </summary>
  5114. <remarks>
  5115. See https://www.postgresql.org/docs/current/static/sql-createdomain.html.
  5116. When PostgreSQL returns a RowDescription for a domain type, the type OID is the base type's
  5117. (so fetching a domain type over text returns a RowDescription for text).
  5118. However, when a composite type is returned, the type OID there is that of the domain,
  5119. so we provide "clean" support for domain types.
  5120. </remarks>
  5121. </member>
  5122. <member name="P:Npgsql.PostgresTypes.PostgresDomainType.BaseType">
  5123. <summary>
  5124. The PostgreSQL data type of the base type, i.e. the type this domain is based on.
  5125. </summary>
  5126. </member>
  5127. <member name="M:Npgsql.PostgresTypes.PostgresDomainType.#ctor(System.String,System.String,System.UInt32,Npgsql.PostgresTypes.PostgresType)">
  5128. <summary>
  5129. Constructs a representation of a PostgreSQL domain data type.
  5130. </summary>
  5131. </member>
  5132. <member name="T:Npgsql.PostgresTypes.PostgresEnumType">
  5133. <summary>
  5134. Represents a PostgreSQL enum data type.
  5135. </summary>
  5136. <remarks>
  5137. See https://www.postgresql.org/docs/current/static/datatype-enum.html.
  5138. </remarks>
  5139. </member>
  5140. <member name="P:Npgsql.PostgresTypes.PostgresEnumType.Labels">
  5141. <summary>
  5142. The enum's fields.
  5143. </summary>
  5144. </member>
  5145. <member name="M:Npgsql.PostgresTypes.PostgresEnumType.#ctor(System.String,System.String,System.UInt32)">
  5146. <summary>
  5147. Constructs a representation of a PostgreSQL enum data type.
  5148. </summary>
  5149. </member>
  5150. <member name="T:Npgsql.PostgresTypes.PostgresRangeType">
  5151. <summary>
  5152. Represents a PostgreSQL range data type.
  5153. </summary>
  5154. <remarks>
  5155. See https://www.postgresql.org/docs/current/static/rangetypes.html.
  5156. </remarks>
  5157. </member>
  5158. <member name="P:Npgsql.PostgresTypes.PostgresRangeType.Subtype">
  5159. <summary>
  5160. The PostgreSQL data type of the subtype of this range.
  5161. </summary>
  5162. </member>
  5163. <member name="M:Npgsql.PostgresTypes.PostgresRangeType.#ctor(System.String,System.String,System.UInt32,Npgsql.PostgresTypes.PostgresType)">
  5164. <summary>
  5165. Constructs a representation of a PostgreSQL range data type.
  5166. </summary>
  5167. </member>
  5168. <member name="T:Npgsql.PostgresTypes.PostgresType">
  5169. <summary>
  5170. Represents a PostgreSQL data type, such as int4 or text, as discovered from pg_type.
  5171. This class is abstract, see derived classes for concrete types of PostgreSQL types.
  5172. </summary>
  5173. <remarks>
  5174. Instances of this class are shared between connections to the same databases.
  5175. For more info about what this class and its subclasses represent, see
  5176. https://www.postgresql.org/docs/current/static/catalog-pg-type.html.
  5177. </remarks>
  5178. </member>
  5179. <member name="M:Npgsql.PostgresTypes.PostgresType.#ctor(System.String,System.String,System.UInt32)">
  5180. <summary>
  5181. Constructs a representation of a PostgreSQL data type.
  5182. </summary>
  5183. <param name="ns">The data type's namespace (or schema).</param>
  5184. <param name="name">The data type's name.</param>
  5185. <param name="oid">The data type's OID.</param>
  5186. </member>
  5187. <member name="M:Npgsql.PostgresTypes.PostgresType.#ctor(System.String,System.String,System.String,System.UInt32)">
  5188. <summary>
  5189. Constructs a representation of a PostgreSQL data type.
  5190. </summary>
  5191. <param name="ns">The data type's namespace (or schema).</param>
  5192. <param name="name">The data type's name.</param>
  5193. <param name="internalName">The data type's internal name (e.g. _int4 for integer[]).</param>
  5194. <param name="oid">The data type's OID.</param>
  5195. </member>
  5196. <member name="P:Npgsql.PostgresTypes.PostgresType.OID">
  5197. <summary>
  5198. The data type's OID - a unique id identifying the data type in a given database (in pg_type).
  5199. </summary>
  5200. </member>
  5201. <member name="P:Npgsql.PostgresTypes.PostgresType.Namespace">
  5202. <summary>
  5203. The data type's namespace (or schema).
  5204. </summary>
  5205. </member>
  5206. <member name="P:Npgsql.PostgresTypes.PostgresType.Name">
  5207. <summary>
  5208. The data type's name.
  5209. </summary>
  5210. <remarks>
  5211. Note that this is the standard, user-displayable type name (e.g. integer[]) rather than the internal
  5212. PostgreSQL name as it is in pg_type (_int4). See <see cref="P:Npgsql.PostgresTypes.PostgresType.InternalName"/> for the latter.
  5213. </remarks>
  5214. </member>
  5215. <member name="P:Npgsql.PostgresTypes.PostgresType.FullName">
  5216. <summary>
  5217. The full name of the backend type, including its namespace.
  5218. </summary>
  5219. </member>
  5220. <member name="P:Npgsql.PostgresTypes.PostgresType.DisplayName">
  5221. <summary>
  5222. A display name for this backend type, including the namespace unless it is pg_catalog (the namespace
  5223. for all built-in types).
  5224. </summary>
  5225. </member>
  5226. <member name="P:Npgsql.PostgresTypes.PostgresType.InternalName">
  5227. <summary>
  5228. The data type's internal PostgreSQL name (e.g. integer[] not _int4).
  5229. See <see cref="P:Npgsql.PostgresTypes.PostgresType.Name"/> for a more user-friendly name.
  5230. </summary>
  5231. </member>
  5232. <member name="P:Npgsql.PostgresTypes.PostgresType.Array">
  5233. <summary>
  5234. If a PostgreSQL array type exists for this type, it will be referenced here.
  5235. Otherwise null.
  5236. </summary>
  5237. </member>
  5238. <member name="P:Npgsql.PostgresTypes.PostgresType.Range">
  5239. <summary>
  5240. If a PostgreSQL range type exists for this type, it will be referenced here.
  5241. Otherwise null.
  5242. </summary>
  5243. </member>
  5244. <member name="M:Npgsql.PostgresTypes.PostgresType.GetDisplayNameWithFacets(System.Int32)">
  5245. <summary>
  5246. Generates the type name including any facts (size, precision, scale), given the PostgreSQL type modifier.
  5247. </summary>
  5248. </member>
  5249. <member name="M:Npgsql.PostgresTypes.PostgresType.ToString">
  5250. <summary>
  5251. Returns a string that represents the current object.
  5252. </summary>
  5253. </member>
  5254. <member name="T:Npgsql.PostgresTypes.UnknownBackendType">
  5255. <summary>
  5256. Represents a PostgreSQL data type that isn't known to Npgsql and cannot be handled.
  5257. </summary>
  5258. </member>
  5259. <member name="M:Npgsql.PostgresTypes.UnknownBackendType.#ctor">
  5260. <summary>
  5261. Constructs a the unknown backend type.
  5262. </summary>
  5263. </member>
  5264. <member name="T:Npgsql.PreparedStatement">
  5265. <summary>
  5266. Internally represents a statement has been prepared, is in the process of being prepared, or is a
  5267. candidate for preparation (i.e. awaiting further usages).
  5268. </summary>
  5269. </member>
  5270. <member name="P:Npgsql.PreparedStatement.IsExplicit">
  5271. <summary>
  5272. If true, the user explicitly requested this statement be prepared. It does not get closed as part of
  5273. the automatic preparation LRU mechanism.
  5274. </summary>
  5275. </member>
  5276. <member name="F:Npgsql.PreparedStatement.StatementBeingReplaced">
  5277. <summary>
  5278. If this statement is about to be prepared, but replaces a previous statement which needs to be closed,
  5279. this holds the name of the previous statement. Otherwise null.
  5280. </summary>
  5281. </member>
  5282. <member name="P:Npgsql.PreparedStatement.HandlerParamTypes">
  5283. <summary>
  5284. Contains the handler types for a prepared statement's parameters, for overloaded cases (same SQL, different param types)
  5285. Only populated after the statement has been prepared (i.e. null for candidates).
  5286. </summary>
  5287. </member>
  5288. <member name="T:Npgsql.PreparedState">
  5289. <summary>
  5290. The state of a <see cref="T:Npgsql.PreparedStatement"/>.
  5291. </summary>
  5292. </member>
  5293. <member name="F:Npgsql.PreparedState.NotPrepared">
  5294. <summary>
  5295. The statement hasn't been prepared yet, nor is it in the process of being prepared.
  5296. This is the value for autoprepare candidates which haven't been prepared yet, and is also
  5297. a temporary state during preparation.
  5298. </summary>
  5299. </member>
  5300. <member name="F:Npgsql.PreparedState.ToBePrepared">
  5301. <summary>
  5302. The statement has been selected for preparation, but the preparation hasn't started yet.
  5303. This is a temporary state that only occurs during preparation, and indicates that no
  5304. no protocol message (Parse) has been sent yet.
  5305. </summary>
  5306. </member>
  5307. <member name="F:Npgsql.PreparedState.BeingPrepared">
  5308. <summary>
  5309. The statement is in the process of being prepared. This is a temporary state that only occurs during
  5310. preparation, and indicates that a Parse protocol message for the statement has already been written
  5311. to the write buffer.
  5312. </summary>
  5313. </member>
  5314. <member name="F:Npgsql.PreparedState.Prepared">
  5315. <summary>
  5316. The statement has been fully prepared and can be executed.
  5317. </summary>
  5318. </member>
  5319. <member name="F:Npgsql.PreparedState.BeingUnprepared">
  5320. <summary>
  5321. The statement is in the process of being unprepared. This is a temporary state that only occurs during
  5322. unpreparation. Specifically, it means that a Close message for the statement has already been written
  5323. to the write buffer.
  5324. </summary>
  5325. </member>
  5326. <member name="F:Npgsql.PreparedState.Unprepared">
  5327. <summary>
  5328. The statement has been unprepared and is no longer usable.
  5329. </summary>
  5330. </member>
  5331. <member name="F:Npgsql.PreparedStatementManager.NumPrepared">
  5332. <summary>
  5333. Total number of current prepared statements (whether explicit or automatic).
  5334. </summary>
  5335. </member>
  5336. <member name="T:Npgsql.Schema.DbColumn">
  5337. <summary>
  5338. A copy of corefx's DbColumn, used only in .NET Framework where we don't have it.
  5339. </summary>
  5340. <remarks>
  5341. See https://github.com/dotnet/corefx/blob/master/src/System.Data.Common/src/System/Data/Common/DbColumn.cs
  5342. </remarks>
  5343. </member>
  5344. <member name="M:Npgsql.Schema.DbColumnSchemaGenerator.GenerateOldColumnsQuery(System.String)">
  5345. <summary>
  5346. Stripped-down version of <see cref="M:Npgsql.Schema.DbColumnSchemaGenerator.GenerateColumnsQuery(System.Version,System.String)"/>, mainly to support Amazon Redshift.
  5347. </summary>
  5348. </member>
  5349. <member name="M:Npgsql.Schema.DbColumnSchemaGenerator.ColumnPostConfig(Npgsql.Schema.NpgsqlDbColumn,System.Int32)">
  5350. <summary>
  5351. Performs some post-setup configuration that's common to both table columns and non-columns.
  5352. </summary>
  5353. </member>
  5354. <member name="T:Npgsql.Schema.NpgsqlDbColumn">
  5355. <summary>
  5356. Provides schema information about a column.
  5357. </summary>
  5358. <remarks>
  5359. Note that this can correspond to a field returned in a query which isn't an actual table column
  5360. See https://msdn.microsoft.com/en-us/library/system.data.sqlclient.sqldatareader.getschematable(v=vs.110).aspx
  5361. for information on the meaning of the different fields.
  5362. </remarks>
  5363. </member>
  5364. <member name="M:Npgsql.SqlQueryParser.ParseRawQuery(System.String,System.Boolean,Npgsql.NpgsqlParameterCollection,System.Collections.Generic.List{Npgsql.NpgsqlStatement},System.Boolean)">
  5365. <summary>
  5366. Receives a raw SQL query as passed in by the user, and performs some processing necessary
  5367. before sending to the backend.
  5368. This includes doing parameter placebolder processing (@p => $1), and splitting the query
  5369. up by semicolons if needed (SELECT 1; SELECT 2)
  5370. </summary>
  5371. <param name="sql">Raw user-provided query.</param>
  5372. <param name="standardConformantStrings">Whether the PostgreSQL session is configured to use standard conformant strings.</param>
  5373. <param name="parameters">The parameters configured on the <see cref="T:Npgsql.NpgsqlCommand"/> of this query
  5374. or an empty <see cref="T:Npgsql.NpgsqlParameterCollection"/> if deriveParameters is set to true.</param>
  5375. <param name="statements">An empty list to be populated with the statements parsed by this method</param>
  5376. <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>
  5377. </member>
  5378. <member name="M:Npgsql.TaskExtensions.WithTimeout``1(System.Threading.Tasks.Task{``0},Npgsql.NpgsqlTimeout)">
  5379. <summary>
  5380. Utility that simplifies awaiting a task with a timeout. If the given task does not
  5381. complete within <paramref name="timeout"/>, a <see cref="T:System.TimeoutException"/> is thrown.
  5382. </summary>
  5383. <param name="task">The task to be awaited</param>
  5384. <param name="timeout">How much time to allow <paramref name="task"/> to complete before throwing a <see cref="T:System.TimeoutException"/></param>
  5385. <returns>An awaitable task that represents the original task plus the timeout</returns>
  5386. </member>
  5387. <member name="M:Npgsql.TaskExtensions.WithTimeout(System.Threading.Tasks.Task,Npgsql.NpgsqlTimeout)">
  5388. <summary>
  5389. Utility that simplifies awaiting a task with a timeout. If the given task does not
  5390. complete within <paramref name="timeout"/>, a <see cref="T:System.TimeoutException"/> is thrown.
  5391. </summary>
  5392. <param name="task">The task to be awaited</param>
  5393. <param name="timeout">How much time to allow <paramref name="task"/> to complete before throwing a <see cref="T:System.TimeoutException"/></param>
  5394. <returns>An awaitable task that represents the original task plus the timeout</returns>
  5395. </member>
  5396. <member name="M:Npgsql.TaskExtensions.WithCancellation``1(System.Threading.Tasks.Task{``0},System.Threading.CancellationToken)">
  5397. <summary>
  5398. Allows you to cancel awaiting for a non-cancellable task.
  5399. </summary>
  5400. <remarks>
  5401. Read http://blogs.msdn.com/b/pfxteam/archive/2012/10/05/how-do-i-cancel-non-cancelable-async-operations.aspx
  5402. and be very careful with this.
  5403. </remarks>
  5404. </member>
  5405. <member name="M:Npgsql.TaskExtensions.WithCancellation(System.Threading.Tasks.Task,System.Threading.CancellationToken)">
  5406. <summary>
  5407. Allows you to cancel awaiting for a non-cancellable task.
  5408. </summary>
  5409. <remarks>
  5410. Read http://blogs.msdn.com/b/pfxteam/archive/2012/10/05/how-do-i-cancel-non-cancelable-async-operations.aspx
  5411. and be very careful with this.
  5412. </remarks>
  5413. </member>
  5414. <member name="M:Npgsql.Tls.TlsClientStream.#ctor(System.IO.Stream)">
  5415. <summary>
  5416. Creates a new TlsClientStream with the given underlying stream.
  5417. The handshake must be manually initiated with the method PerformInitialHandshake.
  5418. </summary>
  5419. <param name="baseStream">Base stream</param>
  5420. </member>
  5421. <member name="M:Npgsql.Tls.TlsClientStream.ReadRecord(System.Boolean)">
  5422. <summary>
  5423. Makes sure there is at least one full record available at _readStart.
  5424. Also sets _packetLen (does not include packet header of 5 bytes).
  5425. </summary>
  5426. <returns>True on success, false on End Of Stream.</returns>
  5427. </member>
  5428. <member name="M:Npgsql.Tls.TlsClientStream.Encrypt(System.Int32,System.Int32)">
  5429. <summary>
  5430. Encrypts a record.
  5431. A header should be at startPos containing TLS record type and version.
  5432. At startPos + 5 + ivLen the plaintext should start.
  5433. </summary>
  5434. <param name="startPos">Should point to the beginning of the record (content type)</param>
  5435. <param name="len">Plaintext length (without header)</param>
  5436. <returns>The byte position after the last byte in this encrypted record</returns>
  5437. </member>
  5438. <member name="M:Npgsql.Tls.TlsClientStream.HasBufferedReadData(System.Boolean)">
  5439. <summary>
  5440. This method checks whether there are at least 1 byte that can be read in the buffer.
  5441. If not, but there are renegotiation messages in the buffer, these are first processed.
  5442. This method should be called between each Read and Write to make sure the buffer is empty before writing.
  5443. Only when this method returns false it is safe to call Write.
  5444. </summary>
  5445. <param name="checkNetworkStream">Whether we should also look in the underlying NetworkStream</param>
  5446. <returns>Whether there is available application data</returns>
  5447. </member>
  5448. <member name="M:Npgsql.Tls.Utils.PRF(System.Security.Cryptography.HMAC,System.String,System.Byte[],System.Int32)">
  5449. <summary>
  5450. hmac should be initialized with the secret key
  5451. </summary>
  5452. <param name="hmac"></param>
  5453. <param name="label"></param>
  5454. <param name="seed"></param>
  5455. <param name="bytesNeeded"></param>
  5456. <returns></returns>
  5457. </member>
  5458. <member name="M:Npgsql.TypeHandlers.ArrayHandler.CreateArrayHandler(Npgsql.PostgresTypes.PostgresType)">
  5459. <inheritdoc />
  5460. </member>
  5461. <member name="M:Npgsql.TypeHandlers.ArrayHandler.CreateRangeHandler(Npgsql.PostgresTypes.PostgresType)">
  5462. <inheritdoc />
  5463. </member>
  5464. <member name="T:Npgsql.TypeHandlers.ArrayHandler`1">
  5465. <summary>
  5466. Base class for all type handlers which handle PostgreSQL arrays.
  5467. </summary>
  5468. <remarks>
  5469. http://www.postgresql.org/docs/current/static/arrays.html
  5470. </remarks>
  5471. </member>
  5472. <member name="T:Npgsql.TypeHandlers.ArrayHandlerWithPsv`2">
  5473. <remarks>
  5474. http://www.postgresql.org/docs/current/static/arrays.html
  5475. </remarks>
  5476. <typeparam name="TElement">The .NET type contained as an element within this array</typeparam>
  5477. <typeparam name="TElementPsv">The .NET provider-specific type contained as an element within this array</typeparam>
  5478. </member>
  5479. <member name="T:Npgsql.TypeHandlers.BitStringHandler">
  5480. <summary>
  5481. Handler for the PostgreSQL bit string type.
  5482. Note that for BIT(1), this handler will return a bool by default, to align with SQLClient
  5483. (see discussion https://github.com/npgsql/npgsql/pull/362#issuecomment-59622101).
  5484. </summary>
  5485. <remarks>
  5486. http://www.postgresql.org/docs/current/static/datatype-bit.html
  5487. </remarks>
  5488. </member>
  5489. <member name="T:Npgsql.TypeHandlers.BitStringArrayHandler">
  5490. <summary>
  5491. A special handler for arrays of bit strings.
  5492. Differs from the standard array handlers in that it returns arrays of bool for BIT(1) and arrays
  5493. of BitArray otherwise (just like the scalar BitStringHandler does).
  5494. </summary>
  5495. </member>
  5496. <member name="T:Npgsql.TypeHandlers.BoolHandler">
  5497. <remarks>
  5498. http://www.postgresql.org/docs/current/static/datatype-boolean.html
  5499. </remarks>
  5500. </member>
  5501. <member name="T:Npgsql.TypeHandlers.ByteaHandler">
  5502. <remarks>
  5503. http://www.postgresql.org/docs/current/static/datatype-binary.html
  5504. </remarks>
  5505. </member>
  5506. <member name="M:Npgsql.TypeHandlers.ByteaHandler.Read(Npgsql.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
  5507. <inheritdoc />
  5508. </member>
  5509. <member name="M:Npgsql.TypeHandlers.ByteaHandler.ValidateAndGetLength(System.Byte[],Npgsql.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
  5510. <inheritdoc />
  5511. </member>
  5512. <member name="M:Npgsql.TypeHandlers.ByteaHandler.ValidateAndGetLength(System.ArraySegment{System.Byte},Npgsql.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
  5513. <inheritdoc />
  5514. </member>
  5515. <member name="M:Npgsql.TypeHandlers.ByteaHandler.Write(System.Byte[],Npgsql.NpgsqlWriteBuffer,Npgsql.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean)">
  5516. <inheritdoc />
  5517. </member>
  5518. <member name="M:Npgsql.TypeHandlers.ByteaHandler.Write(System.ArraySegment{System.Byte},Npgsql.NpgsqlWriteBuffer,Npgsql.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean)">
  5519. <inheritdoc />
  5520. </member>
  5521. <member name="T:Npgsql.TypeHandlers.DateTimeHandlers.DateHandler">
  5522. <remarks>
  5523. http://www.postgresql.org/docs/current/static/datatype-datetime.html
  5524. </remarks>
  5525. </member>
  5526. <member name="F:Npgsql.TypeHandlers.DateTimeHandlers.DateHandler._convertInfinityDateTime">
  5527. <summary>
  5528. Whether to convert positive and negative infinity values to DateTime.{Max,Min}Value when
  5529. a DateTime is requested
  5530. </summary>
  5531. </member>
  5532. <member name="M:Npgsql.TypeHandlers.DateTimeHandlers.DateHandler.ReadPsv(Npgsql.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
  5533. <remarks>
  5534. Copied wholesale from Postgresql backend/utils/adt/datetime.c:j2date
  5535. </remarks>
  5536. </member>
  5537. <member name="T:Npgsql.TypeHandlers.DateTimeHandlers.IntervalHandler">
  5538. <remarks>
  5539. http://www.postgresql.org/docs/current/static/datatype-datetime.html
  5540. </remarks>
  5541. </member>
  5542. <member name="F:Npgsql.TypeHandlers.DateTimeHandlers.IntervalHandler._integerFormat">
  5543. <summary>
  5544. A deprecated compile-time option of PostgreSQL switches to a floating-point representation of some date/time
  5545. fields. Some PostgreSQL-like databases (e.g. CrateDB) use floating-point representation by default and do not
  5546. provide the option of switching to integer format.
  5547. </summary>
  5548. </member>
  5549. <member name="T:Npgsql.TypeHandlers.DateTimeHandlers.TimeHandler">
  5550. <remarks>
  5551. http://www.postgresql.org/docs/current/static/datatype-datetime.html
  5552. </remarks>
  5553. </member>
  5554. <member name="F:Npgsql.TypeHandlers.DateTimeHandlers.TimeHandler._integerFormat">
  5555. <summary>
  5556. A deprecated compile-time option of PostgreSQL switches to a floating-point representation of some date/time
  5557. fields. Some PostgreSQL-like databases (e.g. CrateDB) use floating-point representation by default and do not
  5558. provide the option of switching to integer format.
  5559. </summary>
  5560. </member>
  5561. <member name="T:Npgsql.TypeHandlers.DateTimeHandlers.TimestampHandler">
  5562. <remarks>
  5563. http://www.postgresql.org/docs/current/static/datatype-datetime.html
  5564. </remarks>
  5565. </member>
  5566. <member name="F:Npgsql.TypeHandlers.DateTimeHandlers.TimestampHandler._integerFormat">
  5567. <summary>
  5568. A deprecated compile-time option of PostgreSQL switches to a floating-point representation of some date/time
  5569. fields. Some PostgreSQL-like databases (e.g. CrateDB) use floating-point representation by default and do not
  5570. provide the option of switching to integer format.
  5571. </summary>
  5572. </member>
  5573. <member name="F:Npgsql.TypeHandlers.DateTimeHandlers.TimestampHandler.ConvertInfinityDateTime">
  5574. <summary>
  5575. Whether to convert positive and negative infinity values to DateTime.{Max,Min}Value when
  5576. a DateTime is requested
  5577. </summary>
  5578. </member>
  5579. <member name="T:Npgsql.TypeHandlers.DateTimeHandlers.TimestampTzHandler">
  5580. <remarks>
  5581. http://www.postgresql.org/docs/current/static/datatype-datetime.html
  5582. </remarks>
  5583. </member>
  5584. <member name="T:Npgsql.TypeHandlers.DateTimeHandlers.TimeTzHandler">
  5585. <remarks>
  5586. http://www.postgresql.org/docs/current/static/datatype-datetime.html
  5587. </remarks>
  5588. </member>
  5589. <member name="F:Npgsql.TypeHandlers.DateTimeHandlers.TimeTzHandler._integerFormat">
  5590. <summary>
  5591. A deprecated compile-time option of PostgreSQL switches to a floating-point representation of some date/time
  5592. fields. Some PostgreSQL-like databases (e.g. CrateDB) use floating-point representation by default and do not
  5593. provide the option of switching to integer format.
  5594. </summary>
  5595. </member>
  5596. <member name="T:Npgsql.TypeHandlers.IEnumHandler">
  5597. <summary>
  5598. Interface implemented by all concrete handlers which handle enums
  5599. </summary>
  5600. </member>
  5601. <member name="P:Npgsql.TypeHandlers.IEnumHandler.EnumType">
  5602. <summary>
  5603. The CLR enum type mapped to the PostgreSQL enum
  5604. </summary>
  5605. </member>
  5606. <member name="T:Npgsql.TypeHandlers.IEnumTypeHandlerFactory">
  5607. <summary>
  5608. Interface implemented by all enum handler factories.
  5609. Used to expose the name translator for those reflecting enum mappings (e.g. EF Core).
  5610. </summary>
  5611. </member>
  5612. <member name="P:Npgsql.TypeHandlers.IEnumTypeHandlerFactory.NameTranslator">
  5613. <summary>
  5614. The name translator used for this enum.
  5615. </summary>
  5616. </member>
  5617. <member name="T:Npgsql.TypeHandlers.FullTextSearchHandlers.TsQueryHandler">
  5618. <summary>
  5619. http://www.postgresql.org/docs/current/static/datatype-textsearch.html
  5620. </summary>
  5621. </member>
  5622. <member name="T:Npgsql.TypeHandlers.FullTextSearchHandlers.TsVectorHandler">
  5623. <summary>
  5624. http://www.postgresql.org/docs/current/static/datatype-textsearch.html
  5625. </summary>
  5626. </member>
  5627. <member name="T:Npgsql.TypeHandlers.GeometricHandlers.BoxHandler">
  5628. <summary>
  5629. Type handler for the PostgreSQL geometric box type.
  5630. </summary>
  5631. <remarks>
  5632. http://www.postgresql.org/docs/current/static/datatype-geometric.html
  5633. </remarks>
  5634. </member>
  5635. <member name="T:Npgsql.TypeHandlers.GeometricHandlers.CircleHandler">
  5636. <summary>
  5637. Type handler for the PostgreSQL geometric circle type.
  5638. </summary>
  5639. <remarks>
  5640. http://www.postgresql.org/docs/current/static/datatype-geometric.html
  5641. </remarks>
  5642. </member>
  5643. <member name="T:Npgsql.TypeHandlers.GeometricHandlers.LineHandler">
  5644. <summary>
  5645. Type handler for the PostgreSQL geometric line type.
  5646. </summary>
  5647. <remarks>
  5648. http://www.postgresql.org/docs/current/static/datatype-geometric.html
  5649. </remarks>
  5650. </member>
  5651. <member name="T:Npgsql.TypeHandlers.GeometricHandlers.LineSegmentHandler">
  5652. <summary>
  5653. Type handler for the PostgreSQL geometric line segment type.
  5654. </summary>
  5655. <remarks>
  5656. http://www.postgresql.org/docs/current/static/datatype-geometric.html
  5657. </remarks>
  5658. </member>
  5659. <member name="T:Npgsql.TypeHandlers.GeometricHandlers.PathHandler">
  5660. <summary>
  5661. Type handler for the PostgreSQL geometric path segment type (open or closed).
  5662. </summary>
  5663. <remarks>
  5664. http://www.postgresql.org/docs/current/static/datatype-geometric.html
  5665. </remarks>
  5666. </member>
  5667. <member name="T:Npgsql.TypeHandlers.GeometricHandlers.PointHandler">
  5668. <summary>
  5669. Type handler for the PostgreSQL geometric point type.
  5670. </summary>
  5671. <remarks>
  5672. http://www.postgresql.org/docs/current/static/datatype-geometric.html
  5673. </remarks>
  5674. </member>
  5675. <member name="T:Npgsql.TypeHandlers.GeometricHandlers.PolygonHandler">
  5676. <summary>
  5677. Type handler for the PostgreSQL geometric polygon type.
  5678. </summary>
  5679. <remarks>
  5680. http://www.postgresql.org/docs/current/static/datatype-geometric.html
  5681. </remarks>
  5682. </member>
  5683. <member name="F:Npgsql.TypeHandlers.HstoreHandler._textHandler">
  5684. <summary>
  5685. The text handler to which we delegate encoding/decoding of the actual strings
  5686. </summary>
  5687. </member>
  5688. <member name="T:Npgsql.TypeHandlers.InternalCharHandler">
  5689. <summary>
  5690. Type handler for the Postgresql "char" type, used only internally
  5691. </summary>
  5692. <remarks>
  5693. http://www.postgresql.org/docs/current/static/datatype-character.html
  5694. </remarks>
  5695. </member>
  5696. <member name="T:Npgsql.TypeHandlers.InternalTypesHandlers.Int2VectorHandler">
  5697. <summary>
  5698. An int2vector is simply a regular array of shorts, with the sole exception that its lower bound must
  5699. be 0 (we send 1 for regular arrays).
  5700. </summary>
  5701. </member>
  5702. <member name="T:Npgsql.TypeHandlers.InternalTypesHandlers.OIDVectorHandler">
  5703. <summary>
  5704. An OIDVector is simply a regular array of uints, with the sole exception that its lower bound must
  5705. be 0 (we send 1 for regular arrays).
  5706. </summary>
  5707. </member>
  5708. <member name="T:Npgsql.TypeHandlers.JsonbHandler">
  5709. <summary>
  5710. JSONB binary encoding is a simple UTF8 string, but prepended with a version number.
  5711. </summary>
  5712. </member>
  5713. <member name="F:Npgsql.TypeHandlers.JsonbHandler.JsonbProtocolVersion">
  5714. <summary>
  5715. Prepended to the string in the wire encoding
  5716. </summary>
  5717. </member>
  5718. <member name="P:Npgsql.TypeHandlers.IMappedCompositeHandler.CompositeType">
  5719. <summary>
  5720. The CLR type mapped to the PostgreSQL composite type.
  5721. </summary>
  5722. </member>
  5723. <member name="T:Npgsql.TypeHandlers.IMappedCompositeTypeHandlerFactory">
  5724. <summary>
  5725. Interface implemented by all mapped composite handler factories.
  5726. Used to expose the name translator for those reflecting enum mappings (e.g. EF Core).
  5727. </summary>
  5728. </member>
  5729. <member name="P:Npgsql.TypeHandlers.IMappedCompositeTypeHandlerFactory.NameTranslator">
  5730. <summary>
  5731. The name translator used for this enum.
  5732. </summary>
  5733. </member>
  5734. <member name="P:Npgsql.TypeHandlers.IMappedEnumHandler.EnumType">
  5735. <summary>
  5736. The CLR type mapped to the PostgreSQL composite type.
  5737. </summary>
  5738. </member>
  5739. <member name="T:Npgsql.TypeHandlers.NetworkHandlers.CidrHandler">
  5740. <remarks>
  5741. http://www.postgresql.org/docs/current/static/datatype-net-types.html
  5742. </remarks>
  5743. </member>
  5744. <member name="T:Npgsql.TypeHandlers.NetworkHandlers.InetHandler">
  5745. <remarks>
  5746. http://www.postgresql.org/docs/current/static/datatype-net-types.html
  5747. </remarks>
  5748. </member>
  5749. <member name="T:Npgsql.TypeHandlers.NetworkHandlers.Macaddr8Handler">
  5750. <remarks>
  5751. http://www.postgresql.org/docs/current/static/datatype-net-types.html
  5752. </remarks>
  5753. </member>
  5754. <member name="T:Npgsql.TypeHandlers.NetworkHandlers.MacaddrHandler">
  5755. <remarks>
  5756. http://www.postgresql.org/docs/current/static/datatype-net-types.html
  5757. </remarks>
  5758. </member>
  5759. <member name="T:Npgsql.TypeHandlers.NumericHandlers.DoubleHandler">
  5760. <remarks>
  5761. http://www.postgresql.org/docs/current/static/datatype-numeric.html
  5762. </remarks>
  5763. </member>
  5764. <member name="T:Npgsql.TypeHandlers.NumericHandlers.Int16Handler">
  5765. <remarks>
  5766. http://www.postgresql.org/docs/current/static/datatype-numeric.html
  5767. </remarks>
  5768. </member>
  5769. <member name="T:Npgsql.TypeHandlers.NumericHandlers.Int32Handler">
  5770. <remarks>
  5771. http://www.postgresql.org/docs/current/static/datatype-numeric.html
  5772. </remarks>
  5773. </member>
  5774. <member name="T:Npgsql.TypeHandlers.NumericHandlers.Int64Handler">
  5775. <remarks>
  5776. http://www.postgresql.org/docs/current/static/datatype-numeric.html
  5777. </remarks>
  5778. </member>
  5779. <member name="T:Npgsql.TypeHandlers.NumericHandlers.MoneyHandler">
  5780. <remarks>
  5781. http://www.postgresql.org/docs/current/static/datatype-money.html
  5782. </remarks>
  5783. </member>
  5784. <member name="T:Npgsql.TypeHandlers.NumericHandlers.NumericHandler">
  5785. <remarks>
  5786. http://www.postgresql.org/docs/current/static/datatype-numeric.html
  5787. </remarks>
  5788. </member>
  5789. <member name="T:Npgsql.TypeHandlers.NumericHandlers.SingleHandler">
  5790. <remarks>
  5791. http://www.postgresql.org/docs/current/static/datatype-numeric.html
  5792. </remarks>
  5793. </member>
  5794. <member name="T:Npgsql.TypeHandlers.NumericHandlers.UInt32Handler">
  5795. <remarks>
  5796. http://www.postgresql.org/docs/current/static/datatype-oid.html
  5797. </remarks>
  5798. </member>
  5799. <member name="T:Npgsql.TypeHandlers.RangeHandler`1">
  5800. <summary>
  5801. Type handler for PostgreSQL range types
  5802. </summary>
  5803. <remarks>
  5804. Introduced in PostgreSQL 9.2.
  5805. http://www.postgresql.org/docs/current/static/rangetypes.html
  5806. </remarks>
  5807. <typeparam name="TElement">the range subtype</typeparam>
  5808. </member>
  5809. <member name="F:Npgsql.TypeHandlers.RangeHandler`1._elementHandler">
  5810. <summary>
  5811. The type handler for the element that this range type holds
  5812. </summary>
  5813. </member>
  5814. <member name="M:Npgsql.TypeHandlers.RangeHandler`1.CreateArrayHandler(Npgsql.PostgresTypes.PostgresType)">
  5815. <inheritdoc />
  5816. </member>
  5817. <member name="T:Npgsql.TypeHandlers.RecordHandler">
  5818. <summary>
  5819. Type handler for PostgreSQL record types.
  5820. </summary>
  5821. <remarks>
  5822. http://www.postgresql.org/docs/current/static/datatype-pseudo.html
  5823. Encoding (identical to composite):
  5824. A 32-bit integer with the number of columns, then for each column:
  5825. * An OID indicating the type of the column
  5826. * The length of the column(32-bit integer), or -1 if null
  5827. * The column data encoded as binary
  5828. </remarks>
  5829. </member>
  5830. <member name="T:Npgsql.TypeHandlers.UnknownTypeHandler">
  5831. <summary>
  5832. Handles "conversions" for columns sent by the database with unknown OIDs.
  5833. This differs from TextHandler in that its a text-only handler (we don't want to receive binary
  5834. representations of the types registered here).
  5835. Note that this handler is also used in the very initial query that loads the OID mappings
  5836. (chicken and egg problem).
  5837. Also used for sending parameters with unknown types (OID=0)
  5838. </summary>
  5839. </member>
  5840. <member name="T:Npgsql.TypeHandlers.UnmappedCompositeHandler">
  5841. <summary>
  5842. Type handler for PostgreSQL composite types, mapping them to C# dynamic.
  5843. This is the default handler used for composites.
  5844. </summary>
  5845. <seealso cref="T:Npgsql.TypeHandlers.MappedCompositeHandler`1"/>.
  5846. <remarks>
  5847. http://www.postgresql.org/docs/current/static/rowtypes.html
  5848. Encoding:
  5849. A 32-bit integer with the number of columns, then for each column:
  5850. * An OID indicating the type of the column
  5851. * The length of the column(32-bit integer), or -1 if null
  5852. * The column data encoded as binary
  5853. </remarks>
  5854. </member>
  5855. <member name="T:Npgsql.TypeHandlers.UuidHandler">
  5856. <remarks>
  5857. http://www.postgresql.org/docs/current/static/datatype-uuid.html
  5858. </remarks>
  5859. </member>
  5860. <member name="T:Npgsql.TypeHandlers.VoidHandler">
  5861. <remarks>
  5862. http://www.postgresql.org/docs/current/static/datatype-boolean.html
  5863. </remarks>
  5864. </member>
  5865. <member name="T:Npgsql.TypeHandling.DefaultTypeHandlerFactory">
  5866. <summary>
  5867. A type handler factory used to instantiate Npgsql's built-in type handlers.
  5868. </summary>
  5869. </member>
  5870. <member name="T:Npgsql.TypeHandling.INpgsqlSimpleTypeHandler`1">
  5871. <summary>
  5872. Type handlers that wish to support reading other types in additional to the main one can
  5873. implement this interface for all those types.
  5874. </summary>
  5875. </member>
  5876. <member name="M:Npgsql.TypeHandling.INpgsqlSimpleTypeHandler`1.Read(Npgsql.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
  5877. <summary>
  5878. Reads a value of type <typeparamref name="T"/> with the given length from the provided buffer,
  5879. with the assumption that it is entirely present in the provided memory buffer and no I/O will be
  5880. required.
  5881. </summary>
  5882. <param name="buf">The buffer from which to read.</param>
  5883. <param name="len">The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed.</param>
  5884. <param name="fieldDescription">Additional PostgreSQL information about the type, such as the length in varchar(30).</param>
  5885. <returns>The fully-read value.</returns>
  5886. </member>
  5887. <member name="M:Npgsql.TypeHandling.INpgsqlSimpleTypeHandler`1.ValidateAndGetLength(`0,Npgsql.NpgsqlParameter)">
  5888. <summary>
  5889. Responsible for validating that a value represents a value of the correct and which can be
  5890. written for PostgreSQL - if the value cannot be written for any reason, an exception shold be thrown.
  5891. Also returns the byte length needed to write the value.
  5892. </summary>
  5893. <param name="value">The value to be written to PostgreSQL</param>
  5894. <param name="parameter">
  5895. The <see cref="T:Npgsql.NpgsqlParameter"/> instance where this value resides. Can be used to access additional
  5896. information relevant to the write process (e.g. <see cref="P:Npgsql.NpgsqlParameter.Size"/>).
  5897. </param>
  5898. <returns>The number of bytes required to write the value.</returns>
  5899. </member>
  5900. <member name="M:Npgsql.TypeHandling.INpgsqlSimpleTypeHandler`1.Write(`0,Npgsql.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
  5901. <summary>
  5902. Writes a value to the provided buffer, with the assumption that there is enough space in the buffer
  5903. (no I/O will occur). The Npgsql core will have taken care of that.
  5904. </summary>
  5905. <param name="value">The value to write.</param>
  5906. <param name="buf">The buffer to which to write.</param>
  5907. <param name="parameter">
  5908. The <see cref="T:Npgsql.NpgsqlParameter"/> instance where this value resides. Can be used to access additional
  5909. information relevant to the write process (e.g. <see cref="P:Npgsql.NpgsqlParameter.Size"/>).
  5910. </param>
  5911. </member>
  5912. <member name="T:Npgsql.TypeHandling.INpgsqlTypeHandler`1">
  5913. <summary>
  5914. Type handlers that wish to support reading other types in additional to the main one can
  5915. implement this interface for all those types.
  5916. </summary>
  5917. </member>
  5918. <member name="M:Npgsql.TypeHandling.INpgsqlTypeHandler`1.Read(Npgsql.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
  5919. <summary>
  5920. Reads a value of type <typeparamref name="T"/> with the given length from the provided buffer,
  5921. using either sync or async I/O.
  5922. </summary>
  5923. <param name="buf">The buffer from which to read.</param>
  5924. <param name="len">The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed.</param>
  5925. <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>
  5926. <param name="fieldDescription">Additional PostgreSQL information about the type, such as the length in varchar(30).</param>
  5927. <returns>The fully-read value.</returns>
  5928. </member>
  5929. <member name="M:Npgsql.TypeHandling.INpgsqlTypeHandler`1.ValidateAndGetLength(`0,Npgsql.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
  5930. <summary>
  5931. Responsible for validating that a value represents a value of the correct and which can be
  5932. written for PostgreSQL - if the value cannot be written for any reason, an exception shold be thrown.
  5933. Also returns the byte length needed to write the value.
  5934. </summary>
  5935. <param name="value">The value to be written to PostgreSQL</param>
  5936. <param name="lengthCache">A cache where the length calculated during the validation phase can be stored for use at the writing phase.</param>
  5937. <param name="parameter">
  5938. The <see cref="T:Npgsql.NpgsqlParameter"/> instance where this value resides. Can be used to access additional
  5939. information relevant to the write process (e.g. <see cref="P:Npgsql.NpgsqlParameter.Size"/>).
  5940. </param>
  5941. <returns>The number of bytes required to write the value.</returns>
  5942. </member>
  5943. <member name="M:Npgsql.TypeHandling.INpgsqlTypeHandler`1.Write(`0,Npgsql.NpgsqlWriteBuffer,Npgsql.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean)">
  5944. <summary>
  5945. Writes a value to the provided buffer.
  5946. </summary>
  5947. <param name="value">The value to write.</param>
  5948. <param name="buf">The buffer to which to write.</param>
  5949. <param name="lengthCache">A cache where the length calculated during the validation phase can be stored for use at the writing phase.</param>
  5950. <param name="parameter">
  5951. The <see cref="T:Npgsql.NpgsqlParameter"/> instance where this value resides. Can be used to access additional
  5952. information relevant to the write process (e.g. <see cref="P:Npgsql.NpgsqlParameter.Size"/>).
  5953. </param>
  5954. <param name="async">
  5955. If I/O will be necessary (i.e. the buffer is full), determines whether it will be done synchronously or asynchronously.
  5956. </param>
  5957. </member>
  5958. <member name="T:Npgsql.TypeHandling.ITextReaderHandler">
  5959. <summary>
  5960. Implemented by handlers which support <see cref="M:System.Data.Common.DbDataReader.GetTextReader(System.Int32)"/>, returns a standard
  5961. TextReader given a binary Stream.
  5962. </summary>
  5963. </member>
  5964. <member name="T:Npgsql.TypeHandling.NpgsqlSafeReadException">
  5965. <summary>
  5966. Can be thrown by readers to indicate that interpreting the value failed, but the value was read wholly
  5967. and it is safe to continue reading. Any other exception is assumed to leave the buffer in an unknown position,
  5968. losing protocol sync and therefore setting the connector to state Broken.
  5969. Note that an inner exception is mandatory, and will get thrown to the user instead of the NpgsqlSafeReadException.
  5970. </summary>
  5971. </member>
  5972. <member name="M:Npgsql.TypeHandling.NpgsqlSafeReadException.#ctor(System.Exception)">
  5973. <summary>
  5974. Creates an instance of <see cref="T:Npgsql.TypeHandling.NpgsqlSafeReadException"/>.
  5975. </summary>
  5976. <param name="innerException"></param>
  5977. </member>
  5978. <member name="T:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1">
  5979. <summary>
  5980. Base class for all simple type handlers, which read and write short, non-arbitrary lengthed
  5981. values to PostgreSQL. Provides a simpler API to implement when compared to <see cref="T:Npgsql.TypeHandling.NpgsqlTypeHandler"/> -
  5982. Npgsql takes care of all I/O before calling into this type, so no I/O needs to be performed by it.
  5983. </summary>
  5984. <typeparam name="TDefault">
  5985. The default CLR type that this handler will read and write. For example, calling <see cref="M:System.Data.Common.DbDataReader.GetValue(System.Int32)"/>
  5986. on a column with this handler will return a value with type <typeparamref name="TDefault"/>.
  5987. Type handlers can support additional types by implementing <see cref="T:Npgsql.TypeHandling.INpgsqlTypeHandler`1"/>.
  5988. </typeparam>
  5989. </member>
  5990. <member name="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1.#ctor">
  5991. <summary>
  5992. Constructs an <see cref="T:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1"/>.
  5993. </summary>
  5994. </member>
  5995. <member name="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1.Read(Npgsql.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
  5996. <summary>
  5997. Reads a value of type <typeparamref name="TDefault"/> with the given length from the provided buffer,
  5998. with the assumption that it is entirely present in the provided memory buffer and no I/O will be
  5999. required.
  6000. </summary>
  6001. <param name="buf">The buffer from which to read.</param>
  6002. <param name="len">The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed.</param>
  6003. <param name="fieldDescription">Additional PostgreSQL information about the type, such as the length in varchar(30).</param>
  6004. <returns>The fully-read value.</returns>
  6005. </member>
  6006. <member name="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1.Read(Npgsql.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
  6007. <summary>
  6008. Reads a value of type <typeparamref name="TDefault"/> with the given length from the provided buffer,
  6009. using either sync or async I/O. This method is sealed for <see cref="T:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1"/>,
  6010. override <see cref="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1.Read(Npgsql.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)"/>.
  6011. </summary>
  6012. <param name="buf">The buffer from which to read.</param>
  6013. <param name="len">The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed.</param>
  6014. <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>
  6015. <param name="fieldDescription">Additional PostgreSQL information about the type, such as the length in varchar(30).</param>
  6016. <returns>The fully-read value.</returns>
  6017. </member>
  6018. <member name="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1.Read``1(Npgsql.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
  6019. <summary>
  6020. Reads a value of type <typeparamref name="TDefault"/> with the given length from the provided buffer,
  6021. using either sync or async I/O. This method is sealed for <see cref="T:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1"/>.
  6022. </summary>
  6023. <param name="buf">The buffer from which to read.</param>
  6024. <param name="len">The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed.</param>
  6025. <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>
  6026. <param name="fieldDescription">Additional PostgreSQL information about the type, such as the length in varchar(30).</param>
  6027. <returns>The fully-read value.</returns>
  6028. </member>
  6029. <member name="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1.Read``1(Npgsql.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
  6030. <summary>
  6031. Reads a value of type <typeparamref name="TDefault"/> with the given length from the provided buffer.
  6032. with the assumption that it is entirely present in the provided memory buffer and no I/O will be
  6033. required. Type handlers typically don't need to override this - override
  6034. <see cref="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1.Read(Npgsql.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)"/> - but may do
  6035. so in exceptional cases where reading of arbitrary types is required.
  6036. </summary>
  6037. <param name="buf">The buffer from which to read.</param>
  6038. <param name="len">The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed.</param>
  6039. <param name="fieldDescription">Additional PostgreSQL information about the type, such as the length in varchar(30).</param>
  6040. <returns>The fully-read value.</returns>
  6041. </member>
  6042. <member name="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1.ValidateAndGetLength(`0,Npgsql.NpgsqlParameter)">
  6043. <summary>
  6044. Responsible for validating that a value represents a value of the correct and which can be
  6045. written for PostgreSQL - if the value cannot be written for any reason, an exception shold be thrown.
  6046. Also returns the byte length needed to write the value.
  6047. </summary>
  6048. <param name="value">The value to be written to PostgreSQL</param>
  6049. <param name="parameter">
  6050. The <see cref="T:Npgsql.NpgsqlParameter"/> instance where this value resides. Can be used to access additional
  6051. information relevant to the write process (e.g. <see cref="P:Npgsql.NpgsqlParameter.Size"/>).
  6052. </param>
  6053. <returns>The number of bytes required to write the value.</returns>
  6054. </member>
  6055. <member name="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1.Write(`0,Npgsql.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
  6056. <summary>
  6057. Writes a value to the provided buffer, with the assumption that there is enough space in the buffer
  6058. (no I/O will occur). The Npgsql core will have taken care of that.
  6059. </summary>
  6060. <param name="value">The value to write.</param>
  6061. <param name="buf">The buffer to which to write.</param>
  6062. <param name="parameter">
  6063. The <see cref="T:Npgsql.NpgsqlParameter"/> instance where this value resides. Can be used to access additional
  6064. information relevant to the write process (e.g. <see cref="P:Npgsql.NpgsqlParameter.Size"/>).
  6065. </param>
  6066. </member>
  6067. <member name="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1.ValidateAndGetLength``1(``0,Npgsql.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
  6068. <summary>
  6069. This method is sealed, override <see cref="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1.ValidateAndGetLength(`0,Npgsql.NpgsqlParameter)"/>.
  6070. </summary>
  6071. </member>
  6072. <member name="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1.WriteWithLengthInternal``1(``0,Npgsql.NpgsqlWriteBuffer,Npgsql.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean)">
  6073. <summary>
  6074. In the vast majority of cases writing a parameter to the buffer won't need to perform I/O.
  6075. </summary>
  6076. </member>
  6077. <member name="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1.Write(`0,Npgsql.NpgsqlWriteBuffer,Npgsql.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean)">
  6078. <summary>
  6079. Simple type handlers override <see cref="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1.Write(`0,Npgsql.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)"/> instead of this.
  6080. </summary>
  6081. </member>
  6082. <member name="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1.ValidateAndGetLength(`0,Npgsql.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
  6083. <summary>
  6084. Simple type handlers override <see cref="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1.ValidateAndGetLength(`0,Npgsql.NpgsqlParameter)"/> instead of this.
  6085. </summary>
  6086. </member>
  6087. <member name="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1.ValidateObjectAndGetLength(System.Object,Npgsql.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
  6088. <summary>
  6089. Called to validate and get the length of a value of a non-generic <see cref="T:Npgsql.NpgsqlParameter"/>.
  6090. Type handlers generally don't need to override this.
  6091. </summary>
  6092. </member>
  6093. <member name="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1.WriteObjectWithLength(System.Object,Npgsql.NpgsqlWriteBuffer,Npgsql.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean)">
  6094. <summary>
  6095. Called to write the value of a non-generic <see cref="T:Npgsql.NpgsqlParameter"/>.
  6096. Type handlers generally don't need to override this.
  6097. </summary>
  6098. </member>
  6099. <member name="T:Npgsql.TypeHandling.NpgsqlSimpleTypeHandlerWithPsv`2">
  6100. <summary>
  6101. A simple type handler that supports a provider-specific value in addition to its default value.
  6102. This is necessary mainly in cases where the CLR type cannot represent the full range of the
  6103. PostgreSQL type, and a custom CLR type is needed (e.g. <see cref="T:System.DateTime"/> and
  6104. <see cref="T:NpgsqlTypes.NpgsqlDateTime"/>). The provider-specific type <typeparamref name="TPsv"/> will be returned
  6105. from calls to <see cref="M:System.Data.Common.DbDataReader.GetProviderSpecificValue(System.Int32)"/>.
  6106. </summary>
  6107. <typeparam name="TDefault">
  6108. The default CLR type that this handler will read and write. For example, calling <see cref="M:System.Data.Common.DbDataReader.GetValue(System.Int32)"/>
  6109. on a column with this handler will return a value with type <typeparamref name="TDefault"/>.
  6110. Type handlers can support additional types by implementing <see cref="T:Npgsql.TypeHandling.INpgsqlTypeHandler`1"/>.
  6111. </typeparam>
  6112. <typeparam name="TPsv">The provider-specific CLR type that this handler will read and write.</typeparam>
  6113. </member>
  6114. <member name="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandlerWithPsv`2.ReadPsv(Npgsql.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
  6115. <summary>
  6116. Reads a value of type <typeparamref name="TPsv"/> with the given length from the provided buffer,
  6117. with the assumption that it is entirely present in the provided memory buffer and no I/O will be
  6118. required.
  6119. </summary>
  6120. <param name="buf">The buffer from which to read.</param>
  6121. <param name="len">The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed.</param>
  6122. <param name="fieldDescription">Additional PostgreSQL information about the type, such as the length in varchar(30).</param>
  6123. <returns>The fully-read value.</returns>
  6124. </member>
  6125. <member name="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandlerWithPsv`2.ReadPsvAsObject(Npgsql.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
  6126. <summary>
  6127. Reads a column as the type handler's provider-specific type, assuming that it is already entirely
  6128. in memory (i.e. no I/O is necessary). Called by <see cref="T:Npgsql.NpgsqlDefaultDataReader"/>, which
  6129. buffers entire rows in memory.
  6130. </summary>
  6131. </member>
  6132. <member name="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandlerWithPsv`2.ReadPsvAsObject(Npgsql.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
  6133. <summary>
  6134. Reads a column as the type handler's provider-specific type. If it is not already entirely in
  6135. memory, sync or async I/O will be performed as specified by <paramref name="async"/>.
  6136. </summary>
  6137. </member>
  6138. <member name="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandlerWithPsv`2.ValidateAndGetLength(`1,Npgsql.NpgsqlParameter)">
  6139. <summary>
  6140. Responsible for validating that a value represents a value of the correct and which can be
  6141. written for PostgreSQL - if the value cannot be written for any reason, an exception shold be thrown.
  6142. Also returns the byte length needed to write the value.
  6143. </summary>
  6144. <param name="value">The value to be written to PostgreSQL</param>
  6145. <param name="parameter">
  6146. The <see cref="T:Npgsql.NpgsqlParameter"/> instance where this value resides. Can be used to access additional
  6147. information relevant to the write process (e.g. <see cref="P:Npgsql.NpgsqlParameter.Size"/>).
  6148. </param>
  6149. <returns>The number of bytes required to write the value.</returns>
  6150. </member>
  6151. <member name="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandlerWithPsv`2.Write(`1,Npgsql.NpgsqlWriteBuffer,Npgsql.NpgsqlParameter)">
  6152. <summary>
  6153. Writes a value to the provided buffer, with the assumption that there is enough space in the buffer
  6154. (no I/O will occur). The Npgsql core will have taken care of that.
  6155. </summary>
  6156. <param name="value">The value to write.</param>
  6157. <param name="buf">The buffer to which to write.</param>
  6158. <param name="parameter">
  6159. The <see cref="T:Npgsql.NpgsqlParameter"/> instance where this value resides. Can be used to access additional
  6160. information relevant to the write process (e.g. <see cref="P:Npgsql.NpgsqlParameter.Size"/>).
  6161. </param>
  6162. </member>
  6163. <member name="M:Npgsql.TypeHandling.NpgsqlSimpleTypeHandlerWithPsv`2.CreateArrayHandler(Npgsql.PostgresTypes.PostgresType)">
  6164. <inheeritdoc />
  6165. </member>
  6166. <member name="T:Npgsql.TypeHandling.NpgsqlTypeHandler">
  6167. <summary>
  6168. Base class for all type handlers, which read and write CLR types into their PostgreSQL
  6169. binary representation.
  6170. Type handler writers shouldn't inherit from this class, inherit <see cref="T:Npgsql.TypeHandling.NpgsqlTypeHandler"/>
  6171. or <see cref="T:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1"/> instead.
  6172. </summary>
  6173. </member>
  6174. <member name="P:Npgsql.TypeHandling.NpgsqlTypeHandler.PostgresType">
  6175. <summary>
  6176. The PostgreSQL type handled by this type handler. Injected by <see cref="T:Npgsql.TypeHandling.NpgsqlTypeHandlerFactory"/>.
  6177. </summary>
  6178. </member>
  6179. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler.Read``1(Npgsql.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
  6180. <summary>
  6181. Reads a value of type <typeparamref name="TAny"/> with the given length from the provided buffer,
  6182. using either sync or async I/O.
  6183. </summary>
  6184. <param name="buf">The buffer from which to read.</param>
  6185. <param name="len">The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed.</param>
  6186. <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>
  6187. <param name="fieldDescription">Additional PostgreSQL information about the type, such as the length in varchar(30).</param>
  6188. <returns>The fully-read value.</returns>
  6189. </member>
  6190. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler.Read``1(Npgsql.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
  6191. <summary>
  6192. Reads a value of type <typeparamref name="TAny"/> with the given length from the provided buffer,
  6193. with the assumption that it is entirely present in the provided memory buffer and no I/O will be
  6194. required. This can save the overhead of async functions and improves performance.
  6195. </summary>
  6196. <param name="buf">The buffer from which to read.</param>
  6197. <param name="len">The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed.</param>
  6198. <param name="fieldDescription">Additional PostgreSQL information about the type, such as the length in varchar(30).</param>
  6199. <returns>The fully-read value.</returns>
  6200. </member>
  6201. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler.ReadAsObject(Npgsql.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
  6202. <summary>
  6203. Reads a column as the type handler's default read type, assuming that it is already entirely
  6204. in memory (i.e. no I/O is necessary). Called by <see cref="T:Npgsql.NpgsqlDefaultDataReader"/>, which
  6205. buffers entire rows in memory.
  6206. </summary>
  6207. </member>
  6208. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler.ReadAsObject(Npgsql.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
  6209. <summary>
  6210. Reads a column as the type handler's default read type. If it is not already entirely in
  6211. memory, sync or async I/O will be performed as specified by <paramref name="async"/>.
  6212. </summary>
  6213. </member>
  6214. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler.ReadPsvAsObject(Npgsql.NpgsqlReadBuffer,System.Int32,Npgsql.BackendMessages.FieldDescription)">
  6215. <summary>
  6216. Reads a column as the type handler's provider-specific type, assuming that it is already entirely
  6217. in memory (i.e. no I/O is necessary). Called by <see cref="T:Npgsql.NpgsqlDefaultDataReader"/>, which
  6218. buffers entire rows in memory.
  6219. </summary>
  6220. </member>
  6221. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler.ReadPsvAsObject(Npgsql.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
  6222. <summary>
  6223. Reads a column as the type handler's provider-specific type. If it is not already entirely in
  6224. memory, sync or async I/O will be performed as specified by <paramref name="async"/>.
  6225. </summary>
  6226. </member>
  6227. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler.ReadWithLength``1(Npgsql.NpgsqlReadBuffer,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
  6228. <summary>
  6229. Reads a value from the buffer, assuming our read position is at the value's preceding length.
  6230. If the length is -1 (null), this method will return the default value.
  6231. </summary>
  6232. </member>
  6233. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler.ValidateAndGetLength``1(``0,Npgsql.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
  6234. <summary>
  6235. Called to validate and get the length of a value of a generic <see cref="T:Npgsql.NpgsqlParameter`1"/>.
  6236. </summary>
  6237. </member>
  6238. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler.WriteWithLengthInternal``1(``0,Npgsql.NpgsqlWriteBuffer,Npgsql.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean)">
  6239. <summary>
  6240. Called to write the value of a generic <see cref="T:Npgsql.NpgsqlParameter`1"/>.
  6241. </summary>
  6242. </member>
  6243. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler.ValidateObjectAndGetLength(System.Object,Npgsql.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
  6244. <summary>
  6245. Responsible for validating that a value represents a value of the correct and which can be
  6246. written for PostgreSQL - if the value cannot be written for any reason, an exception shold be thrown.
  6247. Also returns the byte length needed to write the value.
  6248. </summary>
  6249. <param name="value">The value to be written to PostgreSQL</param>
  6250. <param name="lengthCache">
  6251. If the byte length calculation is costly (e.g. for UTF-8 strings), its result can be stored in the
  6252. length cache to be reused in the writing process, preventing recalculation.
  6253. </param>
  6254. <param name="parameter">
  6255. The <see cref="T:Npgsql.NpgsqlParameter"/> instance where this value resides. Can be used to access additional
  6256. information relevant to the write process (e.g. <see cref="P:Npgsql.NpgsqlParameter.Size"/>).
  6257. </param>
  6258. <returns>The number of bytes required to write the value.</returns>
  6259. </member>
  6260. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler.WriteObjectWithLength(System.Object,Npgsql.NpgsqlWriteBuffer,Npgsql.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean)">
  6261. <summary>
  6262. Writes a value to the provided buffer, using either sync or async I/O.
  6263. </summary>
  6264. <param name="value">The value to write.</param>
  6265. <param name="buf">The buffer to which to write.</param>
  6266. <param name="lengthCache"></param>
  6267. <param name="parameter">
  6268. The <see cref="T:Npgsql.NpgsqlParameter"/> instance where this value resides. Can be used to access additional
  6269. information relevant to the write process (e.g. <see cref="P:Npgsql.NpgsqlParameter.Size"/>).
  6270. </param>
  6271. <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>
  6272. </member>
  6273. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler.CreateArrayHandler(Npgsql.PostgresTypes.PostgresType)">
  6274. <summary>
  6275. Creates a type handler for arrays of this handler's type.
  6276. </summary>
  6277. </member>
  6278. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler.CreateRangeHandler(Npgsql.PostgresTypes.PostgresType)">
  6279. <summary>
  6280. Creates a type handler for ranges of this handler's type.
  6281. </summary>
  6282. </member>
  6283. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler.CreateConversionButNoParamException(System.Type)">
  6284. <summary>
  6285. Used to create an exception when the provided type can be converted and written, but an
  6286. instance of <see cref="T:Npgsql.NpgsqlParameter"/> is required for caching of the converted value
  6287. (in <see cref="P:Npgsql.NpgsqlParameter.ConvertedValue"/>.
  6288. </summary>
  6289. </member>
  6290. <member name="T:Npgsql.TypeHandling.NpgsqlTypeHandlerFactory">
  6291. <summary>
  6292. Base class for all type handler factories, which construct type handlers that know how
  6293. to read and write CLR types from/to PostgreSQL types.
  6294. Do not inherit from this class, inherit from <see cref="T:Npgsql.TypeHandling.NpgsqlTypeHandlerFactory`1"/> instead.
  6295. </summary>
  6296. </member>
  6297. <member name="P:Npgsql.TypeHandling.NpgsqlTypeHandlerFactory.DefaultValueType">
  6298. <summary>
  6299. The default CLR type that handlers produced by this factory will read and write.
  6300. </summary>
  6301. </member>
  6302. <member name="T:Npgsql.TypeHandling.NpgsqlTypeHandlerFactory`1">
  6303. <summary>
  6304. Base class for all type handler factories, which construct type handlers that know how
  6305. to read and write CLR types from/to PostgreSQL types. Type handler factories are set up
  6306. via <see cref="T:Npgsql.TypeMapping.NpgsqlTypeMapping"/> in either the global or connection-specific type mapper.
  6307. </summary>
  6308. <seealso cref="T:Npgsql.TypeMapping.NpgsqlTypeMapping"/>
  6309. <seealso cref="P:Npgsql.NpgsqlConnection.GlobalTypeMapper"/>
  6310. <seealso cref="P:Npgsql.NpgsqlConnection.TypeMapper"/>
  6311. <typeparam name="TDefault">The default CLR type that handlers produced by this factory will read and write.</typeparam>
  6312. </member>
  6313. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandlerFactory`1.Create(Npgsql.NpgsqlConnection)">
  6314. <summary>
  6315. Creates a type handler. The provided connection can be examined to modify type handler
  6316. behavior based on server settings, etc.
  6317. </summary>
  6318. </member>
  6319. <member name="P:Npgsql.TypeHandling.NpgsqlTypeHandlerFactory`1.DefaultValueType">
  6320. <summary>
  6321. The default CLR type that handlers produced by this factory will read and write.
  6322. </summary>
  6323. </member>
  6324. <member name="T:Npgsql.TypeHandling.NpgsqlTypeHandler`1">
  6325. <summary>
  6326. Base class for all type handlers, which read and write CLR types into their PostgreSQL
  6327. binary representation. Unless your type is arbitrary-length, consider inheriting from
  6328. <see cref="T:Npgsql.TypeHandling.NpgsqlSimpleTypeHandler`1"/> instead.
  6329. </summary>
  6330. <typeparam name="TDefault">
  6331. The default CLR type that this handler will read and write. For example, calling <see cref="M:System.Data.Common.DbDataReader.GetValue(System.Int32)"/>
  6332. on a column with this handler will return a value with type <typeparamref name="TDefault"/>.
  6333. Type handlers can support additional types by implementing <see cref="T:Npgsql.TypeHandling.INpgsqlTypeHandler`1"/>.
  6334. </typeparam>
  6335. </member>
  6336. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler`1.#ctor">
  6337. <summary>
  6338. Constructs an <see cref="T:Npgsql.TypeHandling.NpgsqlTypeHandler`1"/>.
  6339. </summary>
  6340. </member>
  6341. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler`1.Read(Npgsql.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
  6342. <summary>
  6343. Reads a value of type <typeparamref name="TDefault"/> with the given length from the provided buffer,
  6344. using either sync or async I/O.
  6345. </summary>
  6346. <param name="buf">The buffer from which to read.</param>
  6347. <param name="len">The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed.</param>
  6348. <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>
  6349. <param name="fieldDescription">Additional PostgreSQL information about the type, such as the length in varchar(30).</param>
  6350. <returns>The fully-read value.</returns>
  6351. </member>
  6352. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler`1.Read``1(Npgsql.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)">
  6353. <summary>
  6354. Reads a value of type <typeparamref name="TDefault"/> with the given length from the provided buffer,
  6355. using either sync or async I/O. Type handlers typically don't need to override this -
  6356. override <see cref="M:Npgsql.TypeHandling.NpgsqlTypeHandler`1.Read(Npgsql.NpgsqlReadBuffer,System.Int32,System.Boolean,Npgsql.BackendMessages.FieldDescription)"/> - but may do
  6357. so in exceptional cases where reading of arbitrary types is required.
  6358. </summary>
  6359. <param name="buf">The buffer from which to read.</param>
  6360. <param name="len">The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed.</param>
  6361. <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>
  6362. <param name="fieldDescription">Additional PostgreSQL information about the type, such as the length in varchar(30).</param>
  6363. <returns>The fully-read value.</returns>
  6364. </member>
  6365. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler`1.ValidateAndGetLength(`0,Npgsql.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
  6366. <summary>
  6367. Called to validate and get the length of a value of a generic <see cref="T:Npgsql.NpgsqlParameter`1"/>.
  6368. </summary>
  6369. </member>
  6370. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler`1.Write(`0,Npgsql.NpgsqlWriteBuffer,Npgsql.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean)">
  6371. <summary>
  6372. Called to write the value of a generic <see cref="T:Npgsql.NpgsqlParameter`1"/>.
  6373. </summary>
  6374. </member>
  6375. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler`1.ValidateAndGetLength``1(``0,Npgsql.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
  6376. <summary>
  6377. Called to validate and get the length of a value of an arbitrary type.
  6378. Checks that the current handler supports that type and throws an exception otherwise.
  6379. </summary>
  6380. </member>
  6381. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler`1.WriteWithLengthInternal``1(``0,Npgsql.NpgsqlWriteBuffer,Npgsql.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean)">
  6382. <summary>
  6383. In the vast majority of cases writing a parameter to the buffer won't need to perform I/O.
  6384. </summary>
  6385. </member>
  6386. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler`1.WriteWithLength``1(``0,Npgsql.NpgsqlWriteBuffer,Npgsql.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean)">
  6387. <summary>
  6388. Typically does not need to be overridden by type handlers, but may be needed in some
  6389. cases (e.g. <see cref="T:Npgsql.TypeHandlers.ArrayHandler"/>.
  6390. Note that this method assumes it can write 4 bytes of length (already verified by
  6391. <see cref="M:Npgsql.TypeHandling.NpgsqlTypeHandler`1.WriteWithLengthInternal``1(``0,Npgsql.NpgsqlWriteBuffer,Npgsql.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean)"/>).
  6392. </summary>
  6393. </member>
  6394. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler`1.ValidateObjectAndGetLength(System.Object,Npgsql.NpgsqlLengthCache@,Npgsql.NpgsqlParameter)">
  6395. <summary>
  6396. Called to validate and get the length of a value of a non-generic <see cref="T:Npgsql.NpgsqlParameter"/>.
  6397. Type handlers generally don't need to override this.
  6398. </summary>
  6399. </member>
  6400. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler`1.WriteObjectWithLength(System.Object,Npgsql.NpgsqlWriteBuffer,Npgsql.NpgsqlLengthCache,Npgsql.NpgsqlParameter,System.Boolean)">
  6401. <summary>
  6402. Called to write the value of a non-generic <see cref="T:Npgsql.NpgsqlParameter"/>.
  6403. Type handlers generally don't need to override this.
  6404. </summary>
  6405. </member>
  6406. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler`1.CreateArrayHandler(Npgsql.PostgresTypes.PostgresType)">
  6407. <inheritdoc />
  6408. </member>
  6409. <member name="M:Npgsql.TypeHandling.NpgsqlTypeHandler`1.CreateRangeHandler(Npgsql.PostgresTypes.PostgresType)">
  6410. <inheritdoc />
  6411. </member>
  6412. <member name="F:Npgsql.TypeMapping.ConnectorTypeMapper._connector">
  6413. <summary>
  6414. The connector to which this type mapper belongs.
  6415. </summary>
  6416. </member>
  6417. <member name="P:Npgsql.TypeMapping.ConnectorTypeMapper.DatabaseInfo">
  6418. <summary>
  6419. Type information for the database of this mapper. Null for the global mapper.
  6420. </summary>
  6421. </member>
  6422. <member name="F:Npgsql.TypeMapping.ConnectorTypeMapper._byClrType">
  6423. <summary>
  6424. Maps CLR types to their type handlers.
  6425. </summary>
  6426. </member>
  6427. <member name="F:Npgsql.TypeMapping.ConnectorTypeMapper._arrayHandlerByClrType">
  6428. <summary>
  6429. Maps CLR types to their array handlers.
  6430. </summary>
  6431. </member>
  6432. <member name="P:Npgsql.TypeMapping.ConnectorTypeMapper.ChangeCounter">
  6433. <summary>
  6434. Copy of <see cref="P:Npgsql.TypeMapping.GlobalTypeMapper.ChangeCounter"/> at the time when this
  6435. mapper was created, to detect mapping changes. If changes are made to this connection's
  6436. mapper, the change counter is set to -1.
  6437. </summary>
  6438. </member>
  6439. <member name="M:Npgsql.TypeMapping.ConnectorTypeMapper.GetByOID(System.UInt32)">
  6440. <summary>
  6441. Looks up a type handler by its PostgreSQL type's OID.
  6442. </summary>
  6443. <param name="oid">A PostgreSQL type OID</param>
  6444. <returns>A type handler that can be used to encode and decode values.</returns>
  6445. </member>
  6446. <member name="P:Npgsql.TypeMapping.GlobalTypeMapper.ChangeCounter">
  6447. <summary>
  6448. A counter that is incremented whenever a global mapping change occurs.
  6449. Used to invalidate bound type mappers.
  6450. </summary>
  6451. </member>
  6452. <member name="T:Npgsql.TypeMapping.INpgsqlTypeMapper">
  6453. <summary>
  6454. A type mapper, managing how to read and write CLR values to PostgreSQL data types.
  6455. A type mapper exists for each connection, as well as a single global type mapper
  6456. (accessible via <see cref="P:NpgsqlConnection.GlobalTypeMapper"/>).
  6457. </summary>
  6458. <remarks>
  6459. </remarks>
  6460. </member>
  6461. <member name="P:Npgsql.TypeMapping.INpgsqlTypeMapper.DefaultNameTranslator">
  6462. <summary>
  6463. The default name translator to convert CLR type names and member names.
  6464. </summary>
  6465. </member>
  6466. <member name="P:Npgsql.TypeMapping.INpgsqlTypeMapper.Mappings">
  6467. <summary>
  6468. Enumerates all mappings currently set up on this type mapper.
  6469. </summary>
  6470. </member>
  6471. <member name="M:Npgsql.TypeMapping.INpgsqlTypeMapper.AddMapping(Npgsql.TypeMapping.NpgsqlTypeMapping)">
  6472. <summary>
  6473. Adds a new type mapping to this mapper, overwriting any existing mapping in the process.
  6474. </summary>
  6475. </member>
  6476. <member name="M:Npgsql.TypeMapping.INpgsqlTypeMapper.RemoveMapping(System.String)">
  6477. <summary>
  6478. Removes an existing mapping from this mapper. Attempts to read or write this type
  6479. after removal will result in an exception.
  6480. </summary>
  6481. <param name="pgTypeName">A PostgreSQL type name for the type in the database.</param>
  6482. </member>
  6483. <member name="M:Npgsql.TypeMapping.INpgsqlTypeMapper.MapEnum``1(System.String,Npgsql.INpgsqlNameTranslator)">
  6484. <summary>
  6485. Maps a CLR enum to a PostgreSQL enum type.
  6486. </summary>
  6487. <remarks>
  6488. CLR enum labels are mapped by name to PostgreSQL enum labels.
  6489. The translation strategy can be controlled by the <paramref name="nameTranslator"/> parameter,
  6490. which defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>.
  6491. You can also use the <see cref="T:NpgsqlTypes.PgNameAttribute"/> on your enum fields to manually specify a PostgreSQL enum label.
  6492. If there is a discrepancy between the .NET and database labels while an enum is read or written,
  6493. an exception will be raised.
  6494. </remarks>
  6495. <param name="pgName">
  6496. A PostgreSQL type name for the corresponding enum type in the database.
  6497. If null, the name translator given in <paramref name="nameTranslator"/>will be used.
  6498. </param>
  6499. <param name="nameTranslator">
  6500. A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
  6501. Defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>
  6502. </param>
  6503. <typeparam name="TEnum">The .NET enum type to be mapped</typeparam>
  6504. </member>
  6505. <member name="M:Npgsql.TypeMapping.INpgsqlTypeMapper.UnmapEnum``1(System.String,Npgsql.INpgsqlNameTranslator)">
  6506. <summary>
  6507. Removes an existing enum mapping.
  6508. </summary>
  6509. <param name="pgName">
  6510. A PostgreSQL type name for the corresponding enum type in the database.
  6511. If null, the name translator given in <paramref name="nameTranslator"/> will be used.
  6512. </param>
  6513. <param name="nameTranslator">
  6514. A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
  6515. Defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>
  6516. </param>
  6517. </member>
  6518. <member name="M:Npgsql.TypeMapping.INpgsqlTypeMapper.MapComposite``1(System.String,Npgsql.INpgsqlNameTranslator)">
  6519. <summary>
  6520. Maps a CLR type to a PostgreSQL composite type.
  6521. </summary>
  6522. <remarks>
  6523. CLR fields and properties by string to PostgreSQL enum labels.
  6524. The translation strategy can be controlled by the <paramref name="nameTranslator"/> parameter,
  6525. which defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>.
  6526. You can also use the <see cref="T:NpgsqlTypes.PgNameAttribute"/> on your members to manually specify a PostgreSQL enum label.
  6527. If there is a discrepancy between the .NET and database labels while a composite is read or written,
  6528. an exception will be raised.
  6529. </remarks>
  6530. <param name="pgName">
  6531. A PostgreSQL type name for the corresponding enum type in the database.
  6532. If null, the name translator given in <paramref name="nameTranslator"/>will be used.
  6533. </param>
  6534. <param name="nameTranslator">
  6535. A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
  6536. Defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>
  6537. </param>
  6538. <typeparam name="T">The .NET type to be mapped</typeparam>
  6539. </member>
  6540. <member name="M:Npgsql.TypeMapping.INpgsqlTypeMapper.UnmapComposite``1(System.String,Npgsql.INpgsqlNameTranslator)">
  6541. <summary>
  6542. Removes an existing enum mapping.
  6543. </summary>
  6544. <param name="pgName">
  6545. A PostgreSQL type name for the corresponding composite type in the database.
  6546. If null, the name translator given in <paramref name="nameTranslator"/>will be used.
  6547. </param>
  6548. <param name="nameTranslator">
  6549. A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
  6550. Defaults to <see cref="T:Npgsql.NameTranslation.NpgsqlSnakeCaseNameTranslator"/>
  6551. </param>
  6552. </member>
  6553. <member name="M:Npgsql.TypeMapping.INpgsqlTypeMapper.Reset">
  6554. <summary>
  6555. Resets all mapping changes performed on this type mapper and reverts it to its original, starting state.
  6556. </summary>
  6557. </member>
  6558. <member name="T:Npgsql.TypeMapping.NpgsqlTypeMappingBuilder">
  6559. <summary>
  6560. Builds instances of <see cref="T:Npgsql.TypeMapping.NpgsqlTypeMapping"/> for addition into <see cref="T:Npgsql.TypeMapping.INpgsqlTypeMapper"/>.
  6561. </summary>
  6562. </member>
  6563. <member name="P:Npgsql.TypeMapping.NpgsqlTypeMappingBuilder.PgTypeName">
  6564. <summary>
  6565. The name of the PostgreSQL type name, as it appears in the pg_type catalog.
  6566. </summary>
  6567. <remarks>
  6568. This can a a partial name (without the schema), or a fully-qualified name
  6569. (schema.typename) - the latter can be used if you have two types with the same
  6570. name in different schemas.
  6571. </remarks>
  6572. </member>
  6573. <member name="P:Npgsql.TypeMapping.NpgsqlTypeMappingBuilder.NpgsqlDbType">
  6574. <summary>
  6575. The <see cref="P:Npgsql.TypeMapping.NpgsqlTypeMappingBuilder.NpgsqlDbType"/> that corresponds to this type. Setting an
  6576. <see cref="T:Npgsql.NpgsqlParameter"/>'s <see cref="P:Npgsql.NpgsqlParameter.NpgsqlDbType"/> property
  6577. to this value will make Npgsql write its value to PostgreSQL with this mapping.
  6578. </summary>
  6579. </member>
  6580. <member name="P:Npgsql.TypeMapping.NpgsqlTypeMappingBuilder.DbTypes">
  6581. <summary>
  6582. A set of <see cref="T:System.Data.DbType"/>s that correspond to this type. Setting an
  6583. <see cref="T:Npgsql.NpgsqlParameter"/>'s <see cref="P:Npgsql.NpgsqlParameter.DbType"/> property
  6584. to one of these values will make Npgsql write its value to PostgreSQL with this mapping.
  6585. </summary>
  6586. </member>
  6587. <member name="P:Npgsql.TypeMapping.NpgsqlTypeMappingBuilder.ClrTypes">
  6588. <summary>
  6589. A set of CLR types that correspond to this type. Setting an
  6590. <see cref="T:Npgsql.NpgsqlParameter"/>'s <see cref="P:Npgsql.NpgsqlParameter.Value"/> property
  6591. to one of these types will make Npgsql write its value to PostgreSQL with this mapping.
  6592. </summary>
  6593. </member>
  6594. <member name="P:Npgsql.TypeMapping.NpgsqlTypeMappingBuilder.InferredDbType">
  6595. <summary>
  6596. Determines what is returned from <see cref="P:Npgsql.NpgsqlParameter.DbType"/> when this mapping
  6597. is used.
  6598. </summary>
  6599. </member>
  6600. <member name="P:Npgsql.TypeMapping.NpgsqlTypeMappingBuilder.TypeHandlerFactory">
  6601. <summary>
  6602. A factory for a type handler that will be used to read and write values for PostgreSQL type.
  6603. </summary>
  6604. </member>
  6605. <member name="M:Npgsql.TypeMapping.NpgsqlTypeMappingBuilder.Build">
  6606. <summary>
  6607. Builds an <see cref="T:Npgsql.TypeMapping.NpgsqlTypeMapping"/> that can be added to an <see cref="T:Npgsql.TypeMapping.INpgsqlTypeMapper"/>.
  6608. </summary>
  6609. <returns></returns>
  6610. </member>
  6611. <member name="T:Npgsql.TypeMapping.NpgsqlTypeMapping">
  6612. <summary>
  6613. Represents a type mapping for a PostgreSQL data type, which can be added to a type mapper,
  6614. managing when that data type will be read and written and how.
  6615. </summary>
  6616. <seealso cref="P:Npgsql.NpgsqlConnection.GlobalTypeMapper"/>
  6617. <seealso cref="P:Npgsql.NpgsqlConnection.TypeMapper"/>
  6618. </member>
  6619. <member name="P:Npgsql.TypeMapping.NpgsqlTypeMapping.PgTypeName">
  6620. <summary>
  6621. The name of the PostgreSQL type name, as it appears in the pg_type catalog.
  6622. </summary>
  6623. <remarks>
  6624. This can a a partial name (without the schema), or a fully-qualified name
  6625. (schema.typename) - the latter can be used if you have two types with the same
  6626. name in different schemas.
  6627. </remarks>
  6628. </member>
  6629. <member name="P:Npgsql.TypeMapping.NpgsqlTypeMapping.NpgsqlDbType">
  6630. <summary>
  6631. The <see cref="P:Npgsql.TypeMapping.NpgsqlTypeMapping.NpgsqlDbType"/> that corresponds to this type. Setting an
  6632. <see cref="T:Npgsql.NpgsqlParameter"/>'s <see cref="P:Npgsql.NpgsqlParameter.NpgsqlDbType"/> property
  6633. to this value will make Npgsql write its value to PostgreSQL with this mapping.
  6634. </summary>
  6635. </member>
  6636. <member name="P:Npgsql.TypeMapping.NpgsqlTypeMapping.DbTypes">
  6637. <summary>
  6638. A set of <see cref="T:System.Data.DbType"/>s that correspond to this type. Setting an
  6639. <see cref="T:Npgsql.NpgsqlParameter"/>'s <see cref="P:Npgsql.NpgsqlParameter.DbType"/> property
  6640. to one of these values will make Npgsql write its value to PostgreSQL with this mapping.
  6641. </summary>
  6642. </member>
  6643. <member name="P:Npgsql.TypeMapping.NpgsqlTypeMapping.ClrTypes">
  6644. <summary>
  6645. A set of CLR types that correspond to this type. Setting an
  6646. <see cref="T:Npgsql.NpgsqlParameter"/>'s <see cref="P:Npgsql.NpgsqlParameter.Value"/> property
  6647. to one of these types will make Npgsql write its value to PostgreSQL with this mapping.
  6648. </summary>
  6649. </member>
  6650. <member name="P:Npgsql.TypeMapping.NpgsqlTypeMapping.InferredDbType">
  6651. <summary>
  6652. Determines what is returned from <see cref="P:Npgsql.NpgsqlParameter.DbType"/> when this mapping
  6653. is used.
  6654. </summary>
  6655. </member>
  6656. <member name="P:Npgsql.TypeMapping.NpgsqlTypeMapping.TypeHandlerFactory">
  6657. <summary>
  6658. A factory for a type handler that will be used to read and write values for PostgreSQL type.
  6659. </summary>
  6660. </member>
  6661. <member name="P:Npgsql.TypeMapping.NpgsqlTypeMapping.DefaultClrType">
  6662. <summary>
  6663. The default CLR type that handlers produced by this factory will read and write.
  6664. Used by the EF Core provider (and possibly others in the future).
  6665. </summary>
  6666. </member>
  6667. <member name="M:Npgsql.TypeMapping.NpgsqlTypeMapping.ToString">
  6668. <summary>
  6669. Returns a string that represents the current object.
  6670. </summary>
  6671. </member>
  6672. <member name="M:Npgsql.TypeMapping.TypeMappingAttribute.#ctor(System.String,System.Nullable{NpgsqlTypes.NpgsqlDbType},System.Data.DbType[],System.Type[],System.Nullable{System.Data.DbType})">
  6673. <summary>
  6674. Maps an Npgsql type handler to a PostgreSQL type.
  6675. </summary>
  6676. <param name="pgName">A PostgreSQL type name as it appears in the pg_type table.</param>
  6677. <param name="npgsqlDbType">
  6678. A member of <see cref="P:Npgsql.TypeMapping.TypeMappingAttribute.NpgsqlDbType"/> which represents this PostgreSQL type.
  6679. An <see cref="T:Npgsql.NpgsqlParameter"/> with <see cref="P:Npgsql.NpgsqlParameter.NpgsqlDbType"/> set to
  6680. this value will be sent with the type handler mapped by this attribute.
  6681. </param>
  6682. <param name="dbTypes">
  6683. All members of <see cref="T:System.Data.DbType"/> which represent this PostgreSQL type.
  6684. An <see cref="T:Npgsql.NpgsqlParameter"/> with <see cref="P:Npgsql.NpgsqlParameter.DbType"/> set to
  6685. one of these values will be sent with the type handler mapped by this attribute.
  6686. </param>
  6687. <param name="clrTypes">
  6688. Any .NET type which corresponds to this PostgreSQL type.
  6689. An <see cref="T:Npgsql.NpgsqlParameter"/> with <see cref="P:Npgsql.NpgsqlParameter.Value"/> set to
  6690. one of these values will be sent with the type handler mapped by this attribute.
  6691. </param>
  6692. <param name="inferredDbType">
  6693. The "primary" <see cref="T:System.Data.DbType"/> which best corresponds to this PostgreSQL type.
  6694. When <see cref="P:Npgsql.NpgsqlParameter.NpgsqlDbType"/> or <see cref="P:Npgsql.NpgsqlParameter.Value"/>
  6695. set, <see cref="P:Npgsql.NpgsqlParameter.DbType"/> will be set to this value.
  6696. </param>
  6697. </member>
  6698. <member name="M:Npgsql.TypeMapping.TypeMappingAttribute.#ctor(System.String)">
  6699. <summary>
  6700. Read-only parameter
  6701. </summary>
  6702. </member>
  6703. <member name="M:Npgsql.TypeMapping.TypeMappingAttribute.ToString">
  6704. <summary>
  6705. Returns a string that represents the current object.
  6706. </summary>
  6707. <returns></returns>
  6708. </member>
  6709. <member name="M:Npgsql.Util.VersionExtensions.IsGreaterOrEqual(System.Version,System.Int32,System.Int32,System.Int32)">
  6710. <summary>
  6711. Allocation free helper function to find if version is greater than expected
  6712. </summary>
  6713. </member>
  6714. <member name="T:Npgsql.VolatileResourceManager">
  6715. <summary>
  6716. </summary>
  6717. <remarks>
  6718. Note that a connection may be closed before its TransactionScope completes. In this case we close the NpgsqlConnection
  6719. as usual but the connector in a special list in the pool; it will be closed only when the scope completes.
  6720. </remarks>
  6721. </member>
  6722. <member name="F:NpgsqlTypes.NpgsqlDate.Epoch">
  6723. <summary>
  6724. Represents the date 1970-01-01
  6725. </summary>
  6726. </member>
  6727. <member name="F:NpgsqlTypes.NpgsqlDate.Era">
  6728. <summary>
  6729. Represents the date 0001-01-01
  6730. </summary>
  6731. </member>
  6732. <member name="T:NpgsqlTypes.NpgsqlDateTime">
  6733. <summary>
  6734. A struct similar to .NET DateTime but capable of storing PostgreSQL's timestamp and timestamptz types.
  6735. DateTime is capable of storing values from year 1 to 9999 at 100-nanosecond precision,
  6736. while PostgreSQL's timestamps store values from 4713BC to 5874897AD with 1-microsecond precision.
  6737. </summary>
  6738. </member>
  6739. <member name="M:NpgsqlTypes.NpgsqlDateTime.ToDateTime">
  6740. <summary>
  6741. Cast of an <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> to a <see cref="T:System.DateTime"/>.
  6742. </summary>
  6743. <returns>An equivalent <see cref="T:System.DateTime"/>.</returns>
  6744. </member>
  6745. <member name="M:NpgsqlTypes.NpgsqlDateTime.ToUniversalTime">
  6746. <summary>
  6747. Converts the value of the current <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> object to Coordinated Universal Time (UTC).
  6748. </summary>
  6749. <remarks>
  6750. See the MSDN documentation for DateTime.ToUniversalTime().
  6751. <b>Note:</b> this method <b>only</b> takes into account the time zone's base offset, and does
  6752. <b>not</b> respect daylight savings. See https://github.com/npgsql/npgsql/pull/684 for more
  6753. details.
  6754. </remarks>
  6755. </member>
  6756. <member name="M:NpgsqlTypes.NpgsqlDateTime.ToLocalTime">
  6757. <summary>
  6758. Converts the value of the current <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> object to local time.
  6759. </summary>
  6760. <remarks>
  6761. See the MSDN documentation for DateTime.ToLocalTime().
  6762. <b>Note:</b> this method <b>only</b> takes into account the time zone's base offset, and does
  6763. <b>not</b> respect daylight savings. See https://github.com/npgsql/npgsql/pull/684 for more
  6764. details.
  6765. </remarks>
  6766. </member>
  6767. <member name="M:NpgsqlTypes.NpgsqlDateTime.Add(NpgsqlTypes.NpgsqlTimeSpan)">
  6768. <summary>
  6769. Returns a new <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> that adds the value of the specified TimeSpan to the value of this instance.
  6770. </summary>
  6771. <param name="value">A positive or negative time interval.</param>
  6772. <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>
  6773. </member>
  6774. <member name="M:NpgsqlTypes.NpgsqlDateTime.Add(System.TimeSpan)">
  6775. <summary>
  6776. 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.
  6777. </summary>
  6778. <param name="value">A positive or negative time interval.</param>
  6779. <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>
  6780. </member>
  6781. <member name="M:NpgsqlTypes.NpgsqlDateTime.AddYears(System.Int32)">
  6782. <summary>
  6783. Returns a new <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> that adds the specified number of years to the value of this instance.
  6784. </summary>
  6785. <param name="value">A number of years. The value parameter can be negative or positive.</param>
  6786. <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>
  6787. </member>
  6788. <member name="M:NpgsqlTypes.NpgsqlDateTime.AddMonths(System.Int32)">
  6789. <summary>
  6790. Returns a new <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> that adds the specified number of months to the value of this instance.
  6791. </summary>
  6792. <param name="value">A number of months. The months parameter can be negative or positive.</param>
  6793. <returns>An object whose value is the sum of the date and time represented by this instance and months.</returns>
  6794. </member>
  6795. <member name="M:NpgsqlTypes.NpgsqlDateTime.AddDays(System.Double)">
  6796. <summary>
  6797. Returns a new <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> that adds the specified number of days to the value of this instance.
  6798. </summary>
  6799. <param name="value">A number of whole and fractional days. The value parameter can be negative or positive.</param>
  6800. <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>
  6801. </member>
  6802. <member name="M:NpgsqlTypes.NpgsqlDateTime.AddHours(System.Double)">
  6803. <summary>
  6804. Returns a new <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> that adds the specified number of hours to the value of this instance.
  6805. </summary>
  6806. <param name="value">A number of whole and fractional hours. The value parameter can be negative or positive.</param>
  6807. <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>
  6808. </member>
  6809. <member name="M:NpgsqlTypes.NpgsqlDateTime.AddMinutes(System.Double)">
  6810. <summary>
  6811. Returns a new <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> that adds the specified number of minutes to the value of this instance.
  6812. </summary>
  6813. <param name="value">A number of whole and fractional minutes. The value parameter can be negative or positive.</param>
  6814. <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>
  6815. </member>
  6816. <member name="M:NpgsqlTypes.NpgsqlDateTime.AddSeconds(System.Double)">
  6817. <summary>
  6818. Returns a new <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> that adds the specified number of minutes to the value of this instance.
  6819. </summary>
  6820. <param name="value">A number of whole and fractional minutes. The value parameter can be negative or positive.</param>
  6821. <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>
  6822. </member>
  6823. <member name="M:NpgsqlTypes.NpgsqlDateTime.AddMilliseconds(System.Double)">
  6824. <summary>
  6825. Returns a new <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> that adds the specified number of milliseconds to the value of this instance.
  6826. </summary>
  6827. <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>
  6828. <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>
  6829. </member>
  6830. <member name="M:NpgsqlTypes.NpgsqlDateTime.AddTicks(System.Int64)">
  6831. <summary>
  6832. Returns a new <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> that adds the specified number of ticks to the value of this instance.
  6833. </summary>
  6834. <param name="value">A number of 100-nanosecond ticks. The value parameter can be positive or negative.</param>
  6835. <returns>An object whose value is the sum of the date and time represented by this instance and the time represented by value.</returns>
  6836. </member>
  6837. <member name="M:NpgsqlTypes.NpgsqlDateTime.op_Implicit(System.DateTime)~NpgsqlTypes.NpgsqlDateTime">
  6838. <summary>
  6839. Implicit cast of a <see cref="T:System.DateTime"/> to an <see cref="T:NpgsqlTypes.NpgsqlDateTime"/>
  6840. </summary>
  6841. <param name="dateTime">A <see cref="T:System.DateTime"/></param>
  6842. <returns>An equivalent <see cref="T:NpgsqlTypes.NpgsqlDateTime"/>.</returns>
  6843. </member>
  6844. <member name="M:NpgsqlTypes.NpgsqlDateTime.op_Explicit(NpgsqlTypes.NpgsqlDateTime)~System.DateTime">
  6845. <summary>
  6846. Explicit cast of an <see cref="T:NpgsqlTypes.NpgsqlDateTime"/> to a <see cref="T:System.DateTime"/>.
  6847. </summary>
  6848. <param name="npgsqlDateTime">An <see cref="T:NpgsqlTypes.NpgsqlDateTime"/>.</param>
  6849. <returns>An equivalent <see cref="T:System.DateTime"/>.</returns>
  6850. </member>
  6851. <member name="T:NpgsqlTypes.NpgsqlDbType">
  6852. <summary>
  6853. Represents a PostgreSQL data type that can be written or read to the database.
  6854. Used in places such as <see cref="P:Npgsql.NpgsqlParameter.NpgsqlDbType"/> to unambiguously specify
  6855. how to encode or decode values.
  6856. </summary>
  6857. <remarks>See http://www.postgresql.org/docs/current/static/datatype.html</remarks>
  6858. </member>
  6859. <member name="F:NpgsqlTypes.NpgsqlDbType.Bigint">
  6860. <summary>
  6861. Corresponds to the PostgreSQL 8-byte "bigint" type.
  6862. </summary>
  6863. <remarks>See http://www.postgresql.org/docs/current/static/datatype-numeric.html</remarks>
  6864. </member>
  6865. <member name="F:NpgsqlTypes.NpgsqlDbType.Double">
  6866. <summary>
  6867. Corresponds to the PostgreSQL 8-byte floating-point "double" type.
  6868. </summary>
  6869. <remarks>See http://www.postgresql.org/docs/current/static/datatype-numeric.html</remarks>
  6870. </member>
  6871. <member name="F:NpgsqlTypes.NpgsqlDbType.Integer">
  6872. <summary>
  6873. Corresponds to the PostgreSQL 4-byte "integer" type.
  6874. </summary>
  6875. <remarks>See http://www.postgresql.org/docs/current/static/datatype-numeric.html</remarks>
  6876. </member>
  6877. <member name="F:NpgsqlTypes.NpgsqlDbType.Numeric">
  6878. <summary>
  6879. Corresponds to the PostgreSQL arbitrary-precision "numeric" type.
  6880. </summary>
  6881. <remarks>See http://www.postgresql.org/docs/current/static/datatype-numeric.html</remarks>
  6882. </member>
  6883. <member name="F:NpgsqlTypes.NpgsqlDbType.Real">
  6884. <summary>
  6885. Corresponds to the PostgreSQL floating-point "real" type.
  6886. </summary>
  6887. <remarks>See http://www.postgresql.org/docs/current/static/datatype-numeric.html</remarks>
  6888. </member>
  6889. <member name="F:NpgsqlTypes.NpgsqlDbType.Smallint">
  6890. <summary>
  6891. Corresponds to the PostgreSQL 2-byte "smallint" type.
  6892. </summary>
  6893. <remarks>See http://www.postgresql.org/docs/current/static/datatype-numeric.html</remarks>
  6894. </member>
  6895. <member name="F:NpgsqlTypes.NpgsqlDbType.Money">
  6896. <summary>
  6897. Corresponds to the PostgreSQL "money" type.
  6898. </summary>
  6899. <remarks>See http://www.postgresql.org/docs/current/static/datatype-money.html</remarks>
  6900. </member>
  6901. <member name="F:NpgsqlTypes.NpgsqlDbType.Boolean">
  6902. <summary>
  6903. Corresponds to the PostgreSQL "boolean" type.
  6904. </summary>
  6905. <remarks>See http://www.postgresql.org/docs/current/static/datatype-boolean.html</remarks>
  6906. </member>
  6907. <member name="F:NpgsqlTypes.NpgsqlDbType.Box">
  6908. <summary>
  6909. Corresponds to the PostgreSQL geometric "box" type.
  6910. </summary>
  6911. <remarks>See http://www.postgresql.org/docs/current/static/datatype-geometric.html</remarks>
  6912. </member>
  6913. <member name="F:NpgsqlTypes.NpgsqlDbType.Circle">
  6914. <summary>
  6915. Corresponds to the PostgreSQL geometric "circle" type.
  6916. </summary>
  6917. <remarks>See http://www.postgresql.org/docs/current/static/datatype-geometric.html</remarks>
  6918. </member>
  6919. <member name="F:NpgsqlTypes.NpgsqlDbType.Line">
  6920. <summary>
  6921. Corresponds to the PostgreSQL geometric "line" type.
  6922. </summary>
  6923. <remarks>See http://www.postgresql.org/docs/current/static/datatype-geometric.html</remarks>
  6924. </member>
  6925. <member name="F:NpgsqlTypes.NpgsqlDbType.LSeg">
  6926. <summary>
  6927. Corresponds to the PostgreSQL geometric "lseg" type.
  6928. </summary>
  6929. <remarks>See http://www.postgresql.org/docs/current/static/datatype-geometric.html</remarks>
  6930. </member>
  6931. <member name="F:NpgsqlTypes.NpgsqlDbType.Path">
  6932. <summary>
  6933. Corresponds to the PostgreSQL geometric "path" type.
  6934. </summary>
  6935. <remarks>See http://www.postgresql.org/docs/current/static/datatype-geometric.html</remarks>
  6936. </member>
  6937. <member name="F:NpgsqlTypes.NpgsqlDbType.Point">
  6938. <summary>
  6939. Corresponds to the PostgreSQL geometric "point" type.
  6940. </summary>
  6941. <remarks>See http://www.postgresql.org/docs/current/static/datatype-geometric.html</remarks>
  6942. </member>
  6943. <member name="F:NpgsqlTypes.NpgsqlDbType.Polygon">
  6944. <summary>
  6945. Corresponds to the PostgreSQL geometric "polygon" type.
  6946. </summary>
  6947. <remarks>See http://www.postgresql.org/docs/current/static/datatype-geometric.html</remarks>
  6948. </member>
  6949. <member name="F:NpgsqlTypes.NpgsqlDbType.Char">
  6950. <summary>
  6951. Corresponds to the PostgreSQL "char(n)" type.
  6952. </summary>
  6953. <remarks>See http://www.postgresql.org/docs/current/static/datatype-character.html</remarks>
  6954. </member>
  6955. <member name="F:NpgsqlTypes.NpgsqlDbType.Text">
  6956. <summary>
  6957. Corresponds to the PostgreSQL "text" type.
  6958. </summary>
  6959. <remarks>See http://www.postgresql.org/docs/current/static/datatype-character.html</remarks>
  6960. </member>
  6961. <member name="F:NpgsqlTypes.NpgsqlDbType.Varchar">
  6962. <summary>
  6963. Corresponds to the PostgreSQL "varchar" type.
  6964. </summary>
  6965. <remarks>See http://www.postgresql.org/docs/current/static/datatype-character.html</remarks>
  6966. </member>
  6967. <member name="F:NpgsqlTypes.NpgsqlDbType.Name">
  6968. <summary>
  6969. Corresponds to the PostgreSQL internal "name" type.
  6970. </summary>
  6971. <remarks>See http://www.postgresql.org/docs/current/static/datatype-character.html</remarks>
  6972. </member>
  6973. <member name="F:NpgsqlTypes.NpgsqlDbType.Citext">
  6974. <summary>
  6975. Corresponds to the PostgreSQL "citext" type for the citext module.
  6976. </summary>
  6977. <remarks>See http://www.postgresql.org/docs/current/static/citext.html</remarks>
  6978. </member>
  6979. <member name="F:NpgsqlTypes.NpgsqlDbType.InternalChar">
  6980. <summary>
  6981. Corresponds to the PostgreSQL "char" type.
  6982. </summary>
  6983. <remarks>
  6984. This is an internal field and should normally not be used for regular applications.
  6985. See http://www.postgresql.org/docs/current/static/datatype-text.html
  6986. </remarks>
  6987. </member>
  6988. <member name="F:NpgsqlTypes.NpgsqlDbType.Bytea">
  6989. <summary>
  6990. Corresponds to the PostgreSQL "bytea" type, holding a raw byte string.
  6991. </summary>
  6992. <remarks>See http://www.postgresql.org/docs/current/static/datatype-binary.html</remarks>
  6993. </member>
  6994. <member name="F:NpgsqlTypes.NpgsqlDbType.Date">
  6995. <summary>
  6996. Corresponds to the PostgreSQL "date" type.
  6997. </summary>
  6998. <remarks>See http://www.postgresql.org/docs/current/static/datatype-datetime.html</remarks>
  6999. </member>
  7000. <member name="F:NpgsqlTypes.NpgsqlDbType.Time">
  7001. <summary>
  7002. Corresponds to the PostgreSQL "time" type.
  7003. </summary>
  7004. <remarks>See http://www.postgresql.org/docs/current/static/datatype-datetime.html</remarks>
  7005. </member>
  7006. <member name="F:NpgsqlTypes.NpgsqlDbType.Timestamp">
  7007. <summary>
  7008. Corresponds to the PostgreSQL "timestamp" type.
  7009. </summary>
  7010. <remarks>See http://www.postgresql.org/docs/current/static/datatype-datetime.html</remarks>
  7011. </member>
  7012. <member name="F:NpgsqlTypes.NpgsqlDbType.TimestampTZ">
  7013. <summary>
  7014. Corresponds to the PostgreSQL "timestamp with time zone" type.
  7015. </summary>
  7016. <remarks>See http://www.postgresql.org/docs/current/static/datatype-datetime.html</remarks>
  7017. </member>
  7018. <member name="F:NpgsqlTypes.NpgsqlDbType.TimestampTz">
  7019. <summary>
  7020. Corresponds to the PostgreSQL "timestamp with time zone" type.
  7021. </summary>
  7022. <remarks>See http://www.postgresql.org/docs/current/static/datatype-datetime.html</remarks>
  7023. </member>
  7024. <member name="F:NpgsqlTypes.NpgsqlDbType.Interval">
  7025. <summary>
  7026. Corresponds to the PostgreSQL "interval" type.
  7027. </summary>
  7028. <remarks>See http://www.postgresql.org/docs/current/static/datatype-datetime.html</remarks>
  7029. </member>
  7030. <member name="F:NpgsqlTypes.NpgsqlDbType.TimeTZ">
  7031. <summary>
  7032. Corresponds to the PostgreSQL "time with time zone" type.
  7033. </summary>
  7034. <remarks>See http://www.postgresql.org/docs/current/static/datatype-datetime.html</remarks>
  7035. </member>
  7036. <member name="F:NpgsqlTypes.NpgsqlDbType.TimeTz">
  7037. <summary>
  7038. Corresponds to the PostgreSQL "time with time zone" type.
  7039. </summary>
  7040. <remarks>See http://www.postgresql.org/docs/current/static/datatype-datetime.html</remarks>
  7041. </member>
  7042. <member name="F:NpgsqlTypes.NpgsqlDbType.Abstime">
  7043. <summary>
  7044. Corresponds to the obsolete PostgreSQL "abstime" type.
  7045. </summary>
  7046. <remarks>See http://www.postgresql.org/docs/current/static/datatype-datetime.html</remarks>
  7047. </member>
  7048. <member name="F:NpgsqlTypes.NpgsqlDbType.Inet">
  7049. <summary>
  7050. Corresponds to the PostgreSQL "inet" type.
  7051. </summary>
  7052. <remarks>See http://www.postgresql.org/docs/current/static/datatype-net-types.html</remarks>
  7053. </member>
  7054. <member name="F:NpgsqlTypes.NpgsqlDbType.Cidr">
  7055. <summary>
  7056. Corresponds to the PostgreSQL "cidr" type, a field storing an IPv4 or IPv6 network.
  7057. </summary>
  7058. <remarks>See http://www.postgresql.org/docs/current/static/datatype-net-types.html</remarks>
  7059. </member>
  7060. <member name="F:NpgsqlTypes.NpgsqlDbType.MacAddr">
  7061. <summary>
  7062. Corresponds to the PostgreSQL "macaddr" type, a field storing a 6-byte physical address.
  7063. </summary>
  7064. <remarks>See http://www.postgresql.org/docs/current/static/datatype-net-types.html</remarks>
  7065. </member>
  7066. <member name="F:NpgsqlTypes.NpgsqlDbType.MacAddr8">
  7067. <summary>
  7068. Corresponds to the PostgreSQL "macaddr8" type, a field storing a 6-byte or 8-byte physical address.
  7069. </summary>
  7070. <remarks>See http://www.postgresql.org/docs/current/static/datatype-net-types.html</remarks>
  7071. </member>
  7072. <member name="F:NpgsqlTypes.NpgsqlDbType.Bit">
  7073. <summary>
  7074. Corresponds to the PostgreSQL "bit" type.
  7075. </summary>
  7076. <remarks>See http://www.postgresql.org/docs/current/static/datatype-bit.html</remarks>
  7077. </member>
  7078. <member name="F:NpgsqlTypes.NpgsqlDbType.Varbit">
  7079. <summary>
  7080. Corresponds to the PostgreSQL "varbit" type, a field storing a variable-length string of bits.
  7081. </summary>
  7082. <remarks>See http://www.postgresql.org/docs/current/static/datatype-boolean.html</remarks>
  7083. </member>
  7084. <member name="F:NpgsqlTypes.NpgsqlDbType.TsVector">
  7085. <summary>
  7086. Corresponds to the PostgreSQL "tsvector" type.
  7087. </summary>
  7088. <remarks>See http://www.postgresql.org/docs/current/static/datatype-textsearch.html</remarks>
  7089. </member>
  7090. <member name="F:NpgsqlTypes.NpgsqlDbType.TsQuery">
  7091. <summary>
  7092. Corresponds to the PostgreSQL "tsquery" type.
  7093. </summary>
  7094. <remarks>See http://www.postgresql.org/docs/current/static/datatype-textsearch.html</remarks>
  7095. </member>
  7096. <member name="F:NpgsqlTypes.NpgsqlDbType.Regconfig">
  7097. <summary>
  7098. Corresponds to the PostgreSQL "tsquery" type.
  7099. </summary>
  7100. <remarks>See http://www.postgresql.org/docs/current/static/datatype-textsearch.html</remarks>
  7101. </member>
  7102. <member name="F:NpgsqlTypes.NpgsqlDbType.Uuid">
  7103. <summary>
  7104. Corresponds to the PostgreSQL "uuid" type.
  7105. </summary>
  7106. <remarks>See http://www.postgresql.org/docs/current/static/datatype-uuid.html</remarks>
  7107. </member>
  7108. <member name="F:NpgsqlTypes.NpgsqlDbType.Xml">
  7109. <summary>
  7110. Corresponds to the PostgreSQL "xml" type.
  7111. </summary>
  7112. <remarks>See http://www.postgresql.org/docs/current/static/datatype-xml.html</remarks>
  7113. </member>
  7114. <member name="F:NpgsqlTypes.NpgsqlDbType.Json">
  7115. <summary>
  7116. Corresponds to the PostgreSQL "json" type, a field storing JSON in text format.
  7117. </summary>
  7118. <remarks>See http://www.postgresql.org/docs/current/static/datatype-json.html</remarks>
  7119. <seealso cref="F:NpgsqlTypes.NpgsqlDbType.Jsonb"/>
  7120. </member>
  7121. <member name="F:NpgsqlTypes.NpgsqlDbType.Jsonb">
  7122. <summary>
  7123. Corresponds to the PostgreSQL "jsonb" type, a field storing JSON in an optimized binary
  7124. format.
  7125. </summary>
  7126. <remarks>
  7127. Supported since PostgreSQL 9.4.
  7128. See http://www.postgresql.org/docs/current/static/datatype-json.html
  7129. </remarks>
  7130. </member>
  7131. <member name="F:NpgsqlTypes.NpgsqlDbType.Hstore">
  7132. <summary>
  7133. Corresponds to the PostgreSQL "hstore" type, a dictionary of string key-value pairs.
  7134. </summary>
  7135. <remarks>See http://www.postgresql.org/docs/current/static/hstore.html</remarks>
  7136. </member>
  7137. <member name="F:NpgsqlTypes.NpgsqlDbType.Array">
  7138. <summary>
  7139. Corresponds to the PostgreSQL "array" type, a variable-length multidimensional array of
  7140. another type. This value must be combined with another value from <see cref="T:NpgsqlTypes.NpgsqlDbType"/>
  7141. via a bit OR (e.g. NpgsqlDbType.Array | NpgsqlDbType.Integer)
  7142. </summary>
  7143. <remarks>See http://www.postgresql.org/docs/current/static/arrays.html</remarks>
  7144. </member>
  7145. <member name="F:NpgsqlTypes.NpgsqlDbType.Range">
  7146. <summary>
  7147. Corresponds to the PostgreSQL "range" type, continuous range of values of specific type.
  7148. This value must be combined with another value from <see cref="T:NpgsqlTypes.NpgsqlDbType"/>
  7149. via a bit OR (e.g. NpgsqlDbType.Range | NpgsqlDbType.Integer)
  7150. </summary>
  7151. <remarks>
  7152. Supported since PostgreSQL 9.2.
  7153. See http://www.postgresql.org/docs/9.2/static/rangetypes.html
  7154. </remarks>
  7155. </member>
  7156. <member name="F:NpgsqlTypes.NpgsqlDbType.Refcursor">
  7157. <summary>
  7158. Corresponds to the PostgreSQL "refcursor" type.
  7159. </summary>
  7160. </member>
  7161. <member name="F:NpgsqlTypes.NpgsqlDbType.Oidvector">
  7162. <summary>
  7163. Corresponds to the PostgreSQL internal "oidvector" type.
  7164. </summary>
  7165. <remarks>See http://www.postgresql.org/docs/current/static/datatype-oid.html</remarks>
  7166. </member>
  7167. <member name="F:NpgsqlTypes.NpgsqlDbType.Int2Vector">
  7168. <summary>
  7169. Corresponds to the PostgreSQL internal "int2vector" type.
  7170. </summary>
  7171. </member>
  7172. <member name="F:NpgsqlTypes.NpgsqlDbType.Oid">
  7173. <summary>
  7174. Corresponds to the PostgreSQL "oid" type.
  7175. </summary>
  7176. <remarks>See http://www.postgresql.org/docs/current/static/datatype-oid.html</remarks>
  7177. </member>
  7178. <member name="F:NpgsqlTypes.NpgsqlDbType.Xid">
  7179. <summary>
  7180. Corresponds to the PostgreSQL "xid" type, an internal transaction identifier.
  7181. </summary>
  7182. <remarks>See http://www.postgresql.org/docs/current/static/datatype-oid.html</remarks>
  7183. </member>
  7184. <member name="F:NpgsqlTypes.NpgsqlDbType.Cid">
  7185. <summary>
  7186. Corresponds to the PostgreSQL "cid" type, an internal command identifier.
  7187. </summary>
  7188. <remarks>See http://www.postgresql.org/docs/current/static/datatype-oid.html</remarks>
  7189. </member>
  7190. <member name="F:NpgsqlTypes.NpgsqlDbType.Regtype">
  7191. <summary>
  7192. Corresponds to the PostgreSQL "regtype" type, a numeric (OID) ID of a type in the pg_type table.
  7193. </summary>
  7194. </member>
  7195. <member name="F:NpgsqlTypes.NpgsqlDbType.Tid">
  7196. <summary>
  7197. Corresponds to the PostgreSQL "tid" type, a tuple id identifying the physical location of a row within its table.
  7198. </summary>
  7199. </member>
  7200. <member name="F:NpgsqlTypes.NpgsqlDbType.Unknown">
  7201. <summary>
  7202. A special value that can be used to send parameter values to the database without
  7203. specifying their type, allowing the database to cast them to another value based on context.
  7204. The value will be converted to a string and send as text.
  7205. </summary>
  7206. <remarks>
  7207. This value shouldn't ordinarily be used, and makes sense only when sending a data type
  7208. unsupported by Npgsql.
  7209. </remarks>
  7210. </member>
  7211. <member name="F:NpgsqlTypes.NpgsqlDbType.Geometry">
  7212. <summary>
  7213. The geometry type for PostgreSQL spatial extension PostGIS.
  7214. </summary>
  7215. </member>
  7216. <member name="F:NpgsqlTypes.NpgsqlDbType.Geography">
  7217. <summary>
  7218. The geography (geodetic) type for PostgreSQL spatial extension PostGIS.
  7219. </summary>
  7220. </member>
  7221. <member name="T:NpgsqlTypes.BuiltInPostgresType">
  7222. <summary>
  7223. Represents a built-in PostgreSQL type as it appears in pg_type, including its name and OID.
  7224. Extension types with variable OIDs are not represented.
  7225. </summary>
  7226. </member>
  7227. <member name="T:NpgsqlTypes.NpgsqlRange`1">
  7228. <summary>
  7229. Represents a PostgreSQL range type.
  7230. </summary>
  7231. <typeparam name="T">The element type of the values in the range.</typeparam>
  7232. <remarks>
  7233. See: https://www.postgresql.org/docs/current/static/rangetypes.html
  7234. </remarks>
  7235. </member>
  7236. <member name="F:NpgsqlTypes.NpgsqlRange`1.EmptyLiteral">
  7237. <summary>
  7238. Defined by PostgreSQL to represent an empty range.
  7239. </summary>
  7240. </member>
  7241. <member name="F:NpgsqlTypes.NpgsqlRange`1.LowerInfinityLiteral">
  7242. <summary>
  7243. Defined by PostgreSQL to represent an infinite lower bound.
  7244. Some element types may have specific handling for this value distinct from a missing or null value.
  7245. </summary>
  7246. </member>
  7247. <member name="F:NpgsqlTypes.NpgsqlRange`1.UpperInfinityLiteral">
  7248. <summary>
  7249. Defined by PostgreSQL to represent an infinite upper bound.
  7250. Some element types may have specific handling for this value distinct from a missing or null value.
  7251. </summary>
  7252. </member>
  7253. <member name="F:NpgsqlTypes.NpgsqlRange`1.NullLiteral">
  7254. <summary>
  7255. Defined by PostgreSQL to represent an null bound.
  7256. Some element types may have specific handling for this value distinct from an infinite or missing value.
  7257. </summary>
  7258. </member>
  7259. <member name="F:NpgsqlTypes.NpgsqlRange`1.LowerInclusiveBound">
  7260. <summary>
  7261. Defined by PostgreSQL to represent a lower inclusive bound.
  7262. </summary>
  7263. </member>
  7264. <member name="F:NpgsqlTypes.NpgsqlRange`1.LowerExclusiveBound">
  7265. <summary>
  7266. Defined by PostgreSQL to represent a lower exclusive bound.
  7267. </summary>
  7268. </member>
  7269. <member name="F:NpgsqlTypes.NpgsqlRange`1.UpperInclusiveBound">
  7270. <summary>
  7271. Defined by PostgreSQL to represent an upper inclusive bound.
  7272. </summary>
  7273. </member>
  7274. <member name="F:NpgsqlTypes.NpgsqlRange`1.UpperExclusiveBound">
  7275. <summary>
  7276. Defined by PostgreSQL to represent an upper exclusive bound.
  7277. </summary>
  7278. </member>
  7279. <member name="F:NpgsqlTypes.NpgsqlRange`1.BoundSeparator">
  7280. <summary>
  7281. Defined by PostgreSQL to separate the values for the upper and lower bounds.
  7282. </summary>
  7283. </member>
  7284. <member name="F:NpgsqlTypes.NpgsqlRange`1.BoundConverter">
  7285. <summary>
  7286. 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"/>.
  7287. </summary>
  7288. </member>
  7289. <member name="F:NpgsqlTypes.NpgsqlRange`1.HasEquatableBounds">
  7290. <summary>
  7291. True if <typeparamref name="T"/> implements <see cref="T:System.IEquatable`1"/>; otherwise, false.
  7292. </summary>
  7293. </member>
  7294. <member name="F:NpgsqlTypes.NpgsqlRange`1.Empty">
  7295. <summary>
  7296. Represents the empty range. This field is read-only.
  7297. </summary>
  7298. </member>
  7299. <member name="P:NpgsqlTypes.NpgsqlRange`1.LowerBound">
  7300. <summary>
  7301. The lower bound of the range. Only valid when <see cref="P:NpgsqlTypes.NpgsqlRange`1.LowerBoundInfinite"/> is false.
  7302. </summary>
  7303. </member>
  7304. <member name="P:NpgsqlTypes.NpgsqlRange`1.UpperBound">
  7305. <summary>
  7306. The upper bound of the range. Only valid when <see cref="P:NpgsqlTypes.NpgsqlRange`1.UpperBoundInfinite"/> is false.
  7307. </summary>
  7308. </member>
  7309. <member name="F:NpgsqlTypes.NpgsqlRange`1.Flags">
  7310. <summary>
  7311. The characteristics of the boundaries.
  7312. </summary>
  7313. </member>
  7314. <member name="P:NpgsqlTypes.NpgsqlRange`1.LowerBoundIsInclusive">
  7315. <summary>
  7316. True if the lower bound is part of the range (i.e. inclusive); otherwise, false.
  7317. </summary>
  7318. </member>
  7319. <member name="P:NpgsqlTypes.NpgsqlRange`1.UpperBoundIsInclusive">
  7320. <summary>
  7321. True if the upper bound is part of the range (i.e. inclusive); otherwise, false.
  7322. </summary>
  7323. </member>
  7324. <member name="P:NpgsqlTypes.NpgsqlRange`1.LowerBoundInfinite">
  7325. <summary>
  7326. True if the lower bound is indefinite (i.e. infinite or unbounded); otherwise, false.
  7327. </summary>
  7328. </member>
  7329. <member name="P:NpgsqlTypes.NpgsqlRange`1.UpperBoundInfinite">
  7330. <summary>
  7331. True if the upper bound is indefinite (i.e. infinite or unbounded); otherwise, false.
  7332. </summary>
  7333. </member>
  7334. <member name="P:NpgsqlTypes.NpgsqlRange`1.IsEmpty">
  7335. <summary>
  7336. True if the range is empty; otherwise, false.
  7337. </summary>
  7338. </member>
  7339. <member name="M:NpgsqlTypes.NpgsqlRange`1.#ctor(`0,`0)">
  7340. <summary>
  7341. Constructs an <see cref="T:NpgsqlTypes.NpgsqlRange`1"/> with inclusive and definite bounds.
  7342. </summary>
  7343. <param name="lowerBound">The lower bound of the range.</param>
  7344. <param name="upperBound">The upper bound of the range.</param>
  7345. </member>
  7346. <member name="M:NpgsqlTypes.NpgsqlRange`1.#ctor(`0,System.Boolean,`0,System.Boolean)">
  7347. <summary>
  7348. Constructs an <see cref="T:NpgsqlTypes.NpgsqlRange`1"/> with definite bounds.
  7349. </summary>
  7350. <param name="lowerBound">The lower bound of the range.</param>
  7351. <param name="lowerBoundIsInclusive">True if the lower bound is is part of the range (i.e. inclusive); otherwise, false.</param>
  7352. <param name="upperBound">The upper bound of the range.</param>
  7353. <param name="upperBoundIsInclusive">True if the upper bound is part of the range (i.e. inclusive); otherwise, false.</param>
  7354. </member>
  7355. <member name="M:NpgsqlTypes.NpgsqlRange`1.#ctor(`0,System.Boolean,System.Boolean,`0,System.Boolean,System.Boolean)">
  7356. <summary>
  7357. Constructs an <see cref="T:NpgsqlTypes.NpgsqlRange`1"/>.
  7358. </summary>
  7359. <param name="lowerBound">The lower bound of the range.</param>
  7360. <param name="lowerBoundIsInclusive">True if the lower bound is is part of the range (i.e. inclusive); otherwise, false.</param>
  7361. <param name="lowerBoundInfinite">True if the lower bound is indefinite (i.e. infinite or unbounded); otherwise, false.</param>
  7362. <param name="upperBound">The upper bound of the range.</param>
  7363. <param name="upperBoundIsInclusive">True if the upper bound is part of the range (i.e. inclusive); otherwise, false.</param>
  7364. <param name="upperBoundInfinite">True if the upper bound is indefinite (i.e. infinite or unbounded); otherwise, false.</param>
  7365. </member>
  7366. <member name="M:NpgsqlTypes.NpgsqlRange`1.#ctor(`0,`0,NpgsqlTypes.RangeFlags)">
  7367. <summary>
  7368. Constructs an <see cref="T:NpgsqlTypes.NpgsqlRange`1"/>.
  7369. </summary>
  7370. <param name="lowerBound">The lower bound of the range.</param>
  7371. <param name="upperBound">The upper bound of the range.</param>
  7372. <param name="flags">The characteristics of the range boundaries.</param>
  7373. </member>
  7374. <member name="M:NpgsqlTypes.NpgsqlRange`1.IsEmptyRange(`0,`0,NpgsqlTypes.RangeFlags)">
  7375. <summary>
  7376. Attempts to determine if the range is malformed or implicitly empty.
  7377. </summary>
  7378. <param name="lowerBound">The lower bound of the range.</param>
  7379. <param name="upperBound">The upper bound of the range.</param>
  7380. <param name="flags">The characteristics of the range boundaries.</param>
  7381. <returns>
  7382. True if the range is implicitly empty; otherwise, false.
  7383. </returns>
  7384. </member>
  7385. <member name="M:NpgsqlTypes.NpgsqlRange`1.EvaluateBoundaryFlags(System.Boolean,System.Boolean,System.Boolean,System.Boolean)">
  7386. <summary>
  7387. Evaluates the boundary flags.
  7388. </summary>
  7389. <param name="lowerBoundIsInclusive">True if the lower bound is is part of the range (i.e. inclusive); otherwise, false.</param>
  7390. <param name="lowerBoundInfinite">True if the lower bound is indefinite (i.e. infinite or unbounded); otherwise, false.</param>
  7391. <param name="upperBoundIsInclusive">True if the upper bound is part of the range (i.e. inclusive); otherwise, false.</param>
  7392. <param name="upperBoundInfinite">True if the upper bound is indefinite (i.e. infinite or unbounded); otherwise, false.</param>
  7393. <returns>
  7394. The boundary characteristics.
  7395. </returns>
  7396. </member>
  7397. <member name="M:NpgsqlTypes.NpgsqlRange`1.op_Equality(NpgsqlTypes.NpgsqlRange{`0},NpgsqlTypes.NpgsqlRange{`0})">
  7398. <summary>
  7399. 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.
  7400. </summary>
  7401. <param name="x">The <see cref="T:NpgsqlTypes.NpgsqlRange`1"/> on the left.</param>
  7402. <param name="y">The <see cref="T:NpgsqlTypes.NpgsqlRange`1"/> on the right.</param>
  7403. <returns>
  7404. 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.
  7405. </returns>
  7406. </member>
  7407. <member name="M:NpgsqlTypes.NpgsqlRange`1.op_Inequality(NpgsqlTypes.NpgsqlRange{`0},NpgsqlTypes.NpgsqlRange{`0})">
  7408. <summary>
  7409. 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.
  7410. </summary>
  7411. <param name="x">The <see cref="T:NpgsqlTypes.NpgsqlRange`1"/> on the left.</param>
  7412. <param name="y">The <see cref="T:NpgsqlTypes.NpgsqlRange`1"/> on the right.</param>
  7413. <returns>
  7414. 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.
  7415. </returns>
  7416. </member>
  7417. <member name="M:NpgsqlTypes.NpgsqlRange`1.Equals(System.Object)">
  7418. <inheritdoc />
  7419. </member>
  7420. <member name="M:NpgsqlTypes.NpgsqlRange`1.Equals(NpgsqlTypes.NpgsqlRange{`0})">
  7421. <inheritdoc />
  7422. </member>
  7423. <member name="M:NpgsqlTypes.NpgsqlRange`1.GetHashCode">
  7424. <inheritdoc />
  7425. </member>
  7426. <member name="M:NpgsqlTypes.NpgsqlRange`1.ToString">
  7427. <inheritdoc />
  7428. </member>
  7429. <member name="M:NpgsqlTypes.NpgsqlRange`1.Parse(System.String)">
  7430. <summary>
  7431. Parses the well-known text representation of a PostgreSQL range type into a <see cref="T:NpgsqlTypes.NpgsqlRange`1"/>.
  7432. </summary>
  7433. <param name="value">A PosgreSQL range type in a well-known text format.</param>
  7434. <returns>
  7435. The <see cref="T:NpgsqlTypes.NpgsqlRange`1"/> represented by the <paramref name="value"/>.
  7436. </returns>
  7437. <exception cref="T:System.FormatException">
  7438. Malformed range literal.
  7439. </exception>
  7440. <exception cref="T:System.FormatException">
  7441. Malformed range literal. Missing left parenthesis or bracket.
  7442. </exception>
  7443. <exception cref="T:System.FormatException">
  7444. Malformed range literal. Missing right parenthesis or bracket.
  7445. </exception>
  7446. <exception cref="T:System.FormatException">
  7447. Malformed range literal. Missing comma after lower bound.
  7448. </exception>
  7449. <remarks>
  7450. See: https://www.postgresql.org/docs/current/static/rangetypes.html
  7451. </remarks>
  7452. </member>
  7453. <member name="T:NpgsqlTypes.NpgsqlRange`1.RangeTypeConverter">
  7454. <inheritdoc />
  7455. <summary>
  7456. Represents a type converter for <see cref="T:NpgsqlTypes.NpgsqlRange`1" />.
  7457. </summary>
  7458. </member>
  7459. <member name="M:NpgsqlTypes.NpgsqlRange`1.RangeTypeConverter.Register">
  7460. <summary>
  7461. Adds a <see cref="T:System.ComponentModel.TypeConverterAttribute"/> to the closed form <see cref="T:NpgsqlTypes.NpgsqlRange`1"/>.
  7462. </summary>
  7463. </member>
  7464. <member name="M:NpgsqlTypes.NpgsqlRange`1.RangeTypeConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)">
  7465. <inheritdoc />
  7466. </member>
  7467. <member name="M:NpgsqlTypes.NpgsqlRange`1.RangeTypeConverter.CanConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Type)">
  7468. <inheritdoc />
  7469. </member>
  7470. <member name="M:NpgsqlTypes.NpgsqlRange`1.RangeTypeConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
  7471. <inheritdoc />
  7472. </member>
  7473. <member name="M:NpgsqlTypes.NpgsqlRange`1.RangeTypeConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
  7474. <inheritdoc />
  7475. </member>
  7476. <member name="T:NpgsqlTypes.RangeFlags">
  7477. <summary>
  7478. Represents characteristics of range type boundaries.
  7479. </summary>
  7480. <remarks>
  7481. See: https://www.postgresql.org/docs/current/static/rangetypes.html
  7482. </remarks>
  7483. </member>
  7484. <member name="F:NpgsqlTypes.RangeFlags.None">
  7485. <summary>
  7486. The default flag. The range is not empty and has boundaries that are definite and exclusive.
  7487. </summary>
  7488. </member>
  7489. <member name="F:NpgsqlTypes.RangeFlags.Empty">
  7490. <summary>
  7491. The range is empty. E.g. '(0,0)', 'empty'.
  7492. </summary>
  7493. </member>
  7494. <member name="F:NpgsqlTypes.RangeFlags.LowerBoundInclusive">
  7495. <summary>
  7496. The lower bound is inclusive. E.g. '[0,5]', '[0,5)', '[0,)'.
  7497. </summary>
  7498. </member>
  7499. <member name="F:NpgsqlTypes.RangeFlags.UpperBoundInclusive">
  7500. <summary>
  7501. The upper bound is inclusive. E.g. '[0,5]', '(0,5]', '(,5]'.
  7502. </summary>
  7503. </member>
  7504. <member name="F:NpgsqlTypes.RangeFlags.LowerBoundInfinite">
  7505. <summary>
  7506. The lower bound is infinite or indefinite. E.g. '(null,5]', '(-infinity,5]', '(,5]'.
  7507. </summary>
  7508. </member>
  7509. <member name="F:NpgsqlTypes.RangeFlags.UpperBoundInfinite">
  7510. <summary>
  7511. The upper bound is infinite or indefinite. E.g. '[0,null)', '[0,infinity)', '[0,)'.
  7512. </summary>
  7513. </member>
  7514. <member name="F:NpgsqlTypes.RangeFlags.Inclusive">
  7515. <summary>
  7516. Both the lower and upper bounds are inclusive.
  7517. </summary>
  7518. </member>
  7519. <member name="F:NpgsqlTypes.RangeFlags.Infinite">
  7520. <summary>
  7521. Both the lower and upper bounds are indefinite.
  7522. </summary>
  7523. </member>
  7524. <member name="F:NpgsqlTypes.RangeFlags.LowerInclusiveInfinite">
  7525. <summary>
  7526. The lower bound is both inclusive and indefinite. This represents an error condition.
  7527. </summary>
  7528. </member>
  7529. <member name="F:NpgsqlTypes.RangeFlags.UpperInclusiveInfinite">
  7530. <summary>
  7531. The upper bound is both inclusive and indefinite. This represents an error condition.
  7532. </summary>
  7533. </member>
  7534. <member name="T:NpgsqlTypes.NpgsqlTimeSpan">
  7535. <summary>
  7536. Represents the PostgreSQL interval datatype.
  7537. </summary>
  7538. <remarks>PostgreSQL differs from .NET in how it's interval type doesn't assume 24 hours in a day
  7539. (to deal with 23- and 25-hour days caused by daylight savings adjustments) and has a concept
  7540. of months that doesn't exist in .NET's <see cref="T:System.TimeSpan"/> class. (Neither datatype
  7541. has any concessions for leap-seconds).
  7542. <para>For most uses just casting to and from TimeSpan will work correctly &#x2014; in particular,
  7543. the results of subtracting one <see cref="T:System.DateTime"/> or the PostgreSQL date, time and
  7544. timestamp types from another should be the same whether you do so in .NET or PostgreSQL &#x2014;
  7545. but if the handling of days and months in PostgreSQL is important to your application then you
  7546. should use this class instead of <see cref="T:System.TimeSpan"/>.</para>
  7547. <para>If you don't know whether these differences are important to your application, they
  7548. probably arent! Just use <see cref="T:System.TimeSpan"/> and do not use this class directly &#x263a;</para>
  7549. <para>To avoid forcing unnecessary provider-specific concerns on users who need not be concerned
  7550. with them a call to <see cref="M:System.Data.IDataRecord.GetValue(System.Int32)"/> on a field containing an
  7551. <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> value will return a <see cref="T:System.TimeSpan"/> rather than an
  7552. <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>. If you need the extra functionality of <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>
  7553. then use <see cref="M:Npgsql.NpgsqlDataReader.GetInterval(System.Int32)"/>.</para>
  7554. </remarks>
  7555. <seealso cref="P:NpgsqlTypes.NpgsqlTimeSpan.Ticks"/>
  7556. <seealso cref="M:NpgsqlTypes.NpgsqlTimeSpan.JustifyDays"/>
  7557. <seealso cref="M:NpgsqlTypes.NpgsqlTimeSpan.JustifyMonths"/>
  7558. <seealso cref="M:NpgsqlTypes.NpgsqlTimeSpan.Canonicalize"/>
  7559. </member>
  7560. <member name="F:NpgsqlTypes.NpgsqlTimeSpan.TicksPerMicrosecond">
  7561. <summary>
  7562. Represents the number of ticks (100ns periods) in one microsecond. This field is constant.
  7563. </summary>
  7564. </member>
  7565. <member name="F:NpgsqlTypes.NpgsqlTimeSpan.TicksPerMillsecond">
  7566. <summary>
  7567. Represents the number of ticks (100ns periods) in one millisecond. This field is constant.
  7568. </summary>
  7569. </member>
  7570. <member name="F:NpgsqlTypes.NpgsqlTimeSpan.TicksPerSecond">
  7571. <summary>
  7572. Represents the number of ticks (100ns periods) in one second. This field is constant.
  7573. </summary>
  7574. </member>
  7575. <member name="F:NpgsqlTypes.NpgsqlTimeSpan.TicksPerMinute">
  7576. <summary>
  7577. Represents the number of ticks (100ns periods) in one minute. This field is constant.
  7578. </summary>
  7579. </member>
  7580. <member name="F:NpgsqlTypes.NpgsqlTimeSpan.TicksPerHour">
  7581. <summary>
  7582. Represents the number of ticks (100ns periods) in one hour. This field is constant.
  7583. </summary>
  7584. </member>
  7585. <member name="F:NpgsqlTypes.NpgsqlTimeSpan.TicksPerDay">
  7586. <summary>
  7587. Represents the number of ticks (100ns periods) in one day. This field is constant.
  7588. </summary>
  7589. </member>
  7590. <member name="F:NpgsqlTypes.NpgsqlTimeSpan.HoursPerDay">
  7591. <summary>
  7592. Represents the number of hours in one day (assuming no daylight savings adjustments). This field is constant.
  7593. </summary>
  7594. </member>
  7595. <member name="F:NpgsqlTypes.NpgsqlTimeSpan.DaysPerMonth">
  7596. <summary>
  7597. Represents the number of days assumed in one month if month justification or unjustifcation is performed.
  7598. This is set to 30 for consistency with PostgreSQL. Note that this is means that month adjustments cause
  7599. a year to be taken as 30 &#xd7; 12 = 360 rather than 356/366 days.
  7600. </summary>
  7601. </member>
  7602. <member name="F:NpgsqlTypes.NpgsqlTimeSpan.TicksPerMonth">
  7603. <summary>
  7604. Represents the number of ticks (100ns periods) in one day, assuming 30 days per month. <seealso cref="F:NpgsqlTypes.NpgsqlTimeSpan.DaysPerMonth"/>
  7605. </summary>
  7606. </member>
  7607. <member name="F:NpgsqlTypes.NpgsqlTimeSpan.MonthsPerYear">
  7608. <summary>
  7609. Represents the number of months in a year. This field is constant.
  7610. </summary>
  7611. </member>
  7612. <member name="F:NpgsqlTypes.NpgsqlTimeSpan.MaxValue">
  7613. <summary>
  7614. Represents the maximum <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>. This field is read-only.
  7615. </summary>
  7616. </member>
  7617. <member name="F:NpgsqlTypes.NpgsqlTimeSpan.MinValue">
  7618. <summary>
  7619. Represents the minimum <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>. This field is read-only.
  7620. </summary>
  7621. </member>
  7622. <member name="F:NpgsqlTypes.NpgsqlTimeSpan.Zero">
  7623. <summary>
  7624. Represents the zero <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>. This field is read-only.
  7625. </summary>
  7626. </member>
  7627. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.#ctor(System.Int64)">
  7628. <summary>
  7629. Initializes a new <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to the specified number of ticks.
  7630. </summary>
  7631. <param name="ticks">A time period expressed in 100ns units.</param>
  7632. </member>
  7633. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.#ctor(System.TimeSpan)">
  7634. <summary>
  7635. Initializes a new <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to hold the same time as a <see cref="T:System.TimeSpan"/>
  7636. </summary>
  7637. <param name="timespan">A time period expressed in a <see cref="T:System.TimeSpan"/></param>
  7638. </member>
  7639. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.#ctor(System.Int32,System.Int32,System.Int64)">
  7640. <summary>
  7641. Initializes a new <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to the specified number of months, days
  7642. &amp; ticks.
  7643. </summary>
  7644. <param name="months">Number of months.</param>
  7645. <param name="days">Number of days.</param>
  7646. <param name="ticks">Number of 100ns units.</param>
  7647. </member>
  7648. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  7649. <summary>
  7650. Initializes a new <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to the specified number of
  7651. days, hours, minutes &amp; seconds.
  7652. </summary>
  7653. <param name="days">Number of days.</param>
  7654. <param name="hours">Number of hours.</param>
  7655. <param name="minutes">Number of minutes.</param>
  7656. <param name="seconds">Number of seconds.</param>
  7657. </member>
  7658. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  7659. <summary>
  7660. Initializes a new <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to the specified number of
  7661. days, hours, minutes, seconds &amp; milliseconds.
  7662. </summary>
  7663. <param name="days">Number of days.</param>
  7664. <param name="hours">Number of hours.</param>
  7665. <param name="minutes">Number of minutes.</param>
  7666. <param name="seconds">Number of seconds.</param>
  7667. <param name="milliseconds">Number of milliseconds.</param>
  7668. </member>
  7669. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  7670. <summary>
  7671. Initializes a new <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to the specified number of
  7672. months, days, hours, minutes, seconds &amp; milliseconds.
  7673. </summary>
  7674. <param name="months">Number of months.</param>
  7675. <param name="days">Number of days.</param>
  7676. <param name="hours">Number of hours.</param>
  7677. <param name="minutes">Number of minutes.</param>
  7678. <param name="seconds">Number of seconds.</param>
  7679. <param name="milliseconds">Number of milliseconds.</param>
  7680. </member>
  7681. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  7682. <summary>
  7683. Initializes a new <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to the specified number of
  7684. years, months, days, hours, minutes, seconds &amp; milliseconds.
  7685. <para>Years are calculated exactly equivalent to 12 months.</para>
  7686. </summary>
  7687. <param name="years">Number of years.</param>
  7688. <param name="months">Number of months.</param>
  7689. <param name="days">Number of days.</param>
  7690. <param name="hours">Number of hours.</param>
  7691. <param name="minutes">Number of minutes.</param>
  7692. <param name="seconds">Number of seconds.</param>
  7693. <param name="milliseconds">Number of milliseconds.</param>
  7694. </member>
  7695. <member name="P:NpgsqlTypes.NpgsqlTimeSpan.Ticks">
  7696. <summary>
  7697. The total number of ticks(100ns units) contained. This is the resolution of the
  7698. <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> type. This ignores the number of days and
  7699. months held. If you want them included use <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.UnjustifyInterval"/> first.
  7700. <remarks>The resolution of the PostgreSQL
  7701. interval type is by default 1&#xb5;s = 1,000 ns. It may be smaller as follows:
  7702. <list type="number">
  7703. <item>
  7704. <term>interval(0)</term>
  7705. <description>resolution of 1s (1 second)</description>
  7706. </item>
  7707. <item>
  7708. <term>interval(1)</term>
  7709. <description>resolution of 100ms = 0.1s (100 milliseconds)</description>
  7710. </item>
  7711. <item>
  7712. <term>interval(2)</term>
  7713. <description>resolution of 10ms = 0.01s (10 milliseconds)</description>
  7714. </item>
  7715. <item>
  7716. <term>interval(3)</term>
  7717. <description>resolution of 1ms = 0.001s (1 millisecond)</description>
  7718. </item>
  7719. <item>
  7720. <term>interval(4)</term>
  7721. <description>resolution of 100&#xb5;s = 0.0001s (100 microseconds)</description>
  7722. </item>
  7723. <item>
  7724. <term>interval(5)</term>
  7725. <description>resolution of 10&#xb5;s = 0.00001s (10 microseconds)</description>
  7726. </item>
  7727. <item>
  7728. <term>interval(6) or interval</term>
  7729. <description>resolution of 1&#xb5;s = 0.000001s (1 microsecond)</description>
  7730. </item>
  7731. </list>
  7732. <para>As such, if the 100-nanosecond resolution is significant to an application, a PostgreSQL interval will
  7733. not suffice for those purposes.</para>
  7734. <para>In more frequent cases though, the resolution of the interval suffices.
  7735. <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> will always suffice to handle the resolution of any interval value, and upon
  7736. writing to the database, will be rounded to the resolution used.</para>
  7737. </remarks>
  7738. <returns>The number of ticks in the instance.</returns>
  7739. </summary>
  7740. </member>
  7741. <member name="P:NpgsqlTypes.NpgsqlTimeSpan.Microseconds">
  7742. <summary>
  7743. Gets the number of whole microseconds held in the instance.
  7744. <returns>An in the range [-999999, 999999].</returns>
  7745. </summary>
  7746. </member>
  7747. <member name="P:NpgsqlTypes.NpgsqlTimeSpan.Milliseconds">
  7748. <summary>
  7749. Gets the number of whole milliseconds held in the instance.
  7750. <returns>An in the range [-999, 999].</returns>
  7751. </summary>
  7752. </member>
  7753. <member name="P:NpgsqlTypes.NpgsqlTimeSpan.Seconds">
  7754. <summary>
  7755. Gets the number of whole seconds held in the instance.
  7756. <returns>An in the range [-59, 59].</returns>
  7757. </summary>
  7758. </member>
  7759. <member name="P:NpgsqlTypes.NpgsqlTimeSpan.Minutes">
  7760. <summary>
  7761. Gets the number of whole minutes held in the instance.
  7762. <returns>An in the range [-59, 59].</returns>
  7763. </summary>
  7764. </member>
  7765. <member name="P:NpgsqlTypes.NpgsqlTimeSpan.Hours">
  7766. <summary>
  7767. Gets the number of whole hours held in the instance.
  7768. <remarks>Note that this can be less than -23 or greater than 23 unless <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.JustifyDays"/>
  7769. has been used to produce this instance.</remarks>
  7770. </summary>
  7771. </member>
  7772. <member name="P:NpgsqlTypes.NpgsqlTimeSpan.Days">
  7773. <summary>
  7774. Gets the number of days held in the instance.
  7775. <remarks>Note that this does not pay attention to a time component with -24 or less hours or
  7776. 24 or more hours, unless <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.JustifyDays"/> has been called to produce this instance.</remarks>
  7777. </summary>
  7778. </member>
  7779. <member name="P:NpgsqlTypes.NpgsqlTimeSpan.Months">
  7780. <summary>
  7781. Gets the number of months held in the instance.
  7782. <remarks>Note that this does not pay attention to a day component with -30 or less days or
  7783. 30 or more days, unless <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.JustifyMonths"/> has been called to produce this instance.</remarks>
  7784. </summary>
  7785. </member>
  7786. <member name="P:NpgsqlTypes.NpgsqlTimeSpan.Time">
  7787. <summary>
  7788. Returns a <see cref="T:System.TimeSpan"/> representing the time component of the instance.
  7789. <remarks>Note that this may have a value beyond the range &#xb1;23:59:59.9999999 unless
  7790. <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.JustifyDays"/> has been called to produce this instance.</remarks>
  7791. </summary>
  7792. </member>
  7793. <member name="P:NpgsqlTypes.NpgsqlTimeSpan.TotalTicks">
  7794. <summary>
  7795. The total number of ticks (100ns units) in the instance, assuming 24 hours in each day and
  7796. 30 days in a month.
  7797. </summary>
  7798. </member>
  7799. <member name="P:NpgsqlTypes.NpgsqlTimeSpan.TotalMicroseconds">
  7800. <summary>
  7801. The total number of microseconds in the instance, assuming 24 hours in each day and
  7802. 30 days in a month.
  7803. </summary>
  7804. </member>
  7805. <member name="P:NpgsqlTypes.NpgsqlTimeSpan.TotalMilliseconds">
  7806. <summary>
  7807. The total number of milliseconds in the instance, assuming 24 hours in each day and
  7808. 30 days in a month.
  7809. </summary>
  7810. </member>
  7811. <member name="P:NpgsqlTypes.NpgsqlTimeSpan.TotalSeconds">
  7812. <summary>
  7813. The total number of seconds in the instance, assuming 24 hours in each day and
  7814. 30 days in a month.
  7815. </summary>
  7816. </member>
  7817. <member name="P:NpgsqlTypes.NpgsqlTimeSpan.TotalMinutes">
  7818. <summary>
  7819. The total number of minutes in the instance, assuming 24 hours in each day and
  7820. 30 days in a month.
  7821. </summary>
  7822. </member>
  7823. <member name="P:NpgsqlTypes.NpgsqlTimeSpan.TotalHours">
  7824. <summary>
  7825. The total number of hours in the instance, assuming 24 hours in each day and
  7826. 30 days in a month.
  7827. </summary>
  7828. </member>
  7829. <member name="P:NpgsqlTypes.NpgsqlTimeSpan.TotalDays">
  7830. <summary>
  7831. The total number of days in the instance, assuming 24 hours in each day and
  7832. 30 days in a month.
  7833. </summary>
  7834. </member>
  7835. <member name="P:NpgsqlTypes.NpgsqlTimeSpan.TotalMonths">
  7836. <summary>
  7837. The total number of months in the instance, assuming 24 hours in each day and
  7838. 30 days in a month.
  7839. </summary>
  7840. </member>
  7841. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.FromTicks(System.Int64)">
  7842. <summary>
  7843. Creates an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> from a number of ticks.
  7844. </summary>
  7845. <param name="ticks">The number of ticks (100ns units) in the interval.</param>
  7846. <returns>A <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> with the given number of ticks.</returns>
  7847. </member>
  7848. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.FromMicroseconds(System.Double)">
  7849. <summary>
  7850. Creates an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> from a number of microseconds.
  7851. </summary>
  7852. <param name="micro">The number of microseconds in the interval.</param>
  7853. <returns>A <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> with the given number of microseconds.</returns>
  7854. </member>
  7855. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.FromMilliseconds(System.Double)">
  7856. <summary>
  7857. Creates an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> from a number of milliseconds.
  7858. </summary>
  7859. <param name="milli">The number of milliseconds in the interval.</param>
  7860. <returns>A <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> with the given number of milliseconds.</returns>
  7861. </member>
  7862. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.FromSeconds(System.Double)">
  7863. <summary>
  7864. Creates an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> from a number of seconds.
  7865. </summary>
  7866. <param name="seconds">The number of seconds in the interval.</param>
  7867. <returns>A <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> with the given number of seconds.</returns>
  7868. </member>
  7869. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.FromMinutes(System.Double)">
  7870. <summary>
  7871. Creates an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> from a number of minutes.
  7872. </summary>
  7873. <param name="minutes">The number of minutes in the interval.</param>
  7874. <returns>A <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> with the given number of minutes.</returns>
  7875. </member>
  7876. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.FromHours(System.Double)">
  7877. <summary>
  7878. Creates an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> from a number of hours.
  7879. </summary>
  7880. <param name="hours">The number of hours in the interval.</param>
  7881. <returns>A <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> with the given number of hours.</returns>
  7882. </member>
  7883. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.FromDays(System.Double)">
  7884. <summary>
  7885. Creates an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> from a number of days.
  7886. </summary>
  7887. <param name="days">The number of days in the interval.</param>
  7888. <returns>A <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> with the given number of days.</returns>
  7889. </member>
  7890. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.FromMonths(System.Double)">
  7891. <summary>
  7892. Creates an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> from a number of months.
  7893. </summary>
  7894. <param name="months">The number of months in the interval.</param>
  7895. <returns>A <see cref="M:NpgsqlTypes.NpgsqlTimeSpan.Canonicalize"/>d <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> with the given number of months.</returns>
  7896. </member>
  7897. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.Add(NpgsqlTypes.NpgsqlTimeSpan)">
  7898. <summary>
  7899. Adds another interval to this instance and returns the result.
  7900. </summary>
  7901. <param name="interval">An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to add to this instance.</param>
  7902. <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"></see> whose values are the sums of the two instances.</returns>
  7903. </member>
  7904. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.Subtract(NpgsqlTypes.NpgsqlTimeSpan)">
  7905. <summary>
  7906. Subtracts another interval from this instance and returns the result.
  7907. </summary>
  7908. <param name="interval">An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to subtract from this instance.</param>
  7909. <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"></see> whose values are the differences of the two instances.</returns>
  7910. </member>
  7911. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.Negate">
  7912. <summary>
  7913. Returns an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> whose value is the negated value of this instance.
  7914. </summary>
  7915. <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> whose value is the negated value of this instance.</returns>
  7916. </member>
  7917. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.Duration">
  7918. <summary>
  7919. This absolute value of this instance. In the case of some, but not all, components being negative,
  7920. the rules used for justification are used to determine if the instance is positive or negative.
  7921. </summary>
  7922. <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> whose value is the absolute value of this instance.</returns>
  7923. </member>
  7924. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.JustifyDays">
  7925. <summary>
  7926. Equivalent to PostgreSQL's justify_days function.
  7927. </summary>
  7928. <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> based on this one, but with any hours outside of the range [-23, 23]
  7929. converted into days.</returns>
  7930. </member>
  7931. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.UnjustifyDays">
  7932. <summary>
  7933. Opposite to PostgreSQL's justify_days function.
  7934. </summary>
  7935. <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> based on this one, but with any days converted to multiples of &#xB1;24hours.</returns>
  7936. </member>
  7937. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.JustifyMonths">
  7938. <summary>
  7939. Equivalent to PostgreSQL's justify_months function.
  7940. </summary>
  7941. <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> based on this one, but with any days outside of the range [-30, 30]
  7942. converted into months.</returns>
  7943. </member>
  7944. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.UnjustifyMonths">
  7945. <summary>
  7946. Opposite to PostgreSQL's justify_months function.
  7947. </summary>
  7948. <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> based on this one, but with any months converted to multiples of &#xB1;30days.</returns>
  7949. </member>
  7950. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.JustifyInterval">
  7951. <summary>
  7952. Equivalent to PostgreSQL's justify_interval function.
  7953. </summary>
  7954. <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> based on this one,
  7955. but with any months converted to multiples of &#xB1;30days
  7956. and then with any days converted to multiples of &#xB1;24hours</returns>
  7957. </member>
  7958. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.UnjustifyInterval">
  7959. <summary>
  7960. Opposite to PostgreSQL's justify_interval function.
  7961. </summary>
  7962. <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> based on this one, but with any months converted to multiples of &#xB1;30days and then any days converted to multiples of &#xB1;24hours;</returns>
  7963. </member>
  7964. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.Canonicalize">
  7965. <summary>
  7966. Produces a canonical NpgslInterval with 0 months and hours in the range of [-23, 23].
  7967. <remarks>
  7968. <para>
  7969. While the fact that for many purposes, two different <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> instances could be considered
  7970. equivalent (e.g. one with 2days, 3hours and one with 1day 27hours) there are different possible canonical forms.
  7971. </para><para>
  7972. E.g. we could move all excess hours into days and all excess days into months and have the most readable form,
  7973. or we could move everything into the ticks and have the form that allows for the easiest arithmetic) the form
  7974. chosen has two important properties that make it the best choice.
  7975. </para><para>First, it is closest two how
  7976. <see cref="T:System.TimeSpan"/> objects are most often represented. Second, it is compatible with results of many
  7977. PostgreSQL functions, particularly with age() and the results of subtracting one date, time or timestamp from
  7978. another.
  7979. </para>
  7980. <para>Note that the results of casting a <see cref="T:System.TimeSpan"/> to <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> is
  7981. canonicalised.</para>
  7982. </remarks>
  7983. </summary>
  7984. <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> based on this one, but with months converted to multiples of &#xB1;30days and with any hours outside of the range [-23, 23]
  7985. converted into days.</returns>
  7986. </member>
  7987. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_Implicit(System.TimeSpan)~NpgsqlTypes.NpgsqlTimeSpan">
  7988. <summary>
  7989. Implicit cast of a <see cref="T:System.TimeSpan"/> to an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>
  7990. </summary>
  7991. <param name="timespan">A <see cref="T:System.TimeSpan"/></param>
  7992. <returns>An eqivalent, canonical, <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>.</returns>
  7993. </member>
  7994. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.ToNpgsqlTimeSpan(System.TimeSpan)">
  7995. <summary>
  7996. Casts a <see cref="T:System.TimeSpan"/> to an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>.
  7997. </summary>
  7998. </member>
  7999. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_Explicit(NpgsqlTypes.NpgsqlTimeSpan)~System.TimeSpan">
  8000. <summary>
  8001. Explicit cast of an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to a <see cref="T:System.TimeSpan"/>.
  8002. </summary>
  8003. <param name="interval">A <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>.</param>
  8004. <returns>An equivalent <see cref="T:System.TimeSpan"/>.</returns>
  8005. </member>
  8006. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.ToTimeSpan(NpgsqlTypes.NpgsqlTimeSpan)">
  8007. <summary>
  8008. Casts an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to a <see cref="T:System.TimeSpan"/>.
  8009. </summary>
  8010. </member>
  8011. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.Equals(NpgsqlTypes.NpgsqlTimeSpan)">
  8012. <summary>
  8013. Returns true if another <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> is exactly the same as this instance.
  8014. </summary>
  8015. <param name="other">An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> for comparison.</param>
  8016. <returns>true if the two <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> instances are exactly the same,
  8017. false otherwise.</returns>
  8018. </member>
  8019. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.Equals(System.Object)">
  8020. <summary>
  8021. Returns true if another object is an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>, that is exactly the same as
  8022. this instance
  8023. </summary>
  8024. <param name="obj">An <see cref="T:System.Object"/> for comparison.</param>
  8025. <returns>true if the argument is an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> and is exactly the same
  8026. as this one, false otherwise.</returns>
  8027. </member>
  8028. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.Compare(NpgsqlTypes.NpgsqlTimeSpan,NpgsqlTypes.NpgsqlTimeSpan)">
  8029. <summary>
  8030. Compares two <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> instances.
  8031. </summary>
  8032. <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>.</param>
  8033. <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>.</param>
  8034. <returns>0 if the two are equal or equivalent. A value greater than zero if x is greater than y,
  8035. a value less than zero if x is less than y.</returns>
  8036. </member>
  8037. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.GetHashCode">
  8038. <summary>
  8039. A hash code suitable for uses with hashing algorithms.
  8040. </summary>
  8041. <returns>An signed integer.</returns>
  8042. </member>
  8043. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.CompareTo(NpgsqlTypes.NpgsqlTimeSpan)">
  8044. <summary>
  8045. Compares this instance with another/
  8046. </summary>
  8047. <param name="other">An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare this with.</param>
  8048. <returns>0 if the instances are equal or equivalent. A value less than zero if
  8049. this instance is less than the argument. A value greater than zero if this instance
  8050. is greater than the instance.</returns>
  8051. </member>
  8052. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.CompareTo(System.Object)">
  8053. <summary>
  8054. Compares this instance with another/
  8055. </summary>
  8056. <param name="other">An object to compare this with.</param>
  8057. <returns>0 if the argument is an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> and the instances are equal or equivalent.
  8058. A value less than zero if the argument is an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> and
  8059. this instance is less than the argument.
  8060. A value greater than zero if the argument is an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> and this instance
  8061. is greater than the instance.</returns>
  8062. A value greater than zero if the argument is null.
  8063. <exception cref="T:System.ArgumentException">The argument is not an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>.</exception>
  8064. </member>
  8065. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.Parse(System.String)">
  8066. <summary>
  8067. Parses a <see cref="T:System.String"/> and returns a <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> instance.
  8068. Designed to use the formats generally returned by PostgreSQL.
  8069. </summary>
  8070. <param name="str">The <see cref="T:System.String"/> to parse.</param>
  8071. <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> represented by the argument.</returns>
  8072. <exception cref="T:System.ArgumentNullException">The string was null.</exception>
  8073. <exception cref="T:System.OverflowException">A value obtained from parsing the string exceeded the values allowed for the relevant component.</exception>
  8074. <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>
  8075. </member>
  8076. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.TryParse(System.String,NpgsqlTypes.NpgsqlTimeSpan@)">
  8077. <summary>
  8078. Attempt to parse a <see cref="T:System.String"/> to produce an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>.
  8079. </summary>
  8080. <param name="str">The <see cref="T:System.String"/> to parse.</param>
  8081. <param name="result">(out) The <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> produced, or <see cref="F:NpgsqlTypes.NpgsqlTimeSpan.Zero"/> if the parsing failed.</param>
  8082. <returns>true if the parsing succeeded, false otherwise.</returns>
  8083. </member>
  8084. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.ToString">
  8085. <summary>
  8086. Create a <see cref="T:System.String"/> representation of the <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> instance.
  8087. The format returned is of the form:
  8088. [M mon[s]] [d day[s]] [HH:mm:ss[.f[f[f[f[f[f[f[f[f]]]]]]]]]]
  8089. A zero <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> is represented as 00:00:00
  8090. <remarks>
  8091. Ticks are 100ns, Postgress resolution is only to 1&#xb5;s at most. Hence we lose 1 or more decimal
  8092. precision in storing values in the database. Despite this, this method will output that extra
  8093. digit of precision. It's forward-compatible with any future increases in resolution up to 100ns,
  8094. and also makes this ToString() more applicable to any other use-case.
  8095. </remarks>
  8096. </summary>
  8097. <returns>The <see cref="T:System.String"/> representation.</returns>
  8098. </member>
  8099. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_Addition(NpgsqlTypes.NpgsqlTimeSpan,NpgsqlTypes.NpgsqlTimeSpan)">
  8100. <summary>
  8101. Adds two <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> together.
  8102. </summary>
  8103. <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to add.</param>
  8104. <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to add.</param>
  8105. <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> whose values are the sum of the arguments.</returns>
  8106. </member>
  8107. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_Subtraction(NpgsqlTypes.NpgsqlTimeSpan,NpgsqlTypes.NpgsqlTimeSpan)">
  8108. <summary>
  8109. Subtracts one <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> from another.
  8110. </summary>
  8111. <param name="x">The <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to subtract the other from.</param>
  8112. <param name="y">The <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to subtract from the other.</param>
  8113. <returns>An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> whose values are the difference of the arguments</returns>
  8114. </member>
  8115. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_Equality(NpgsqlTypes.NpgsqlTimeSpan,NpgsqlTypes.NpgsqlTimeSpan)">
  8116. <summary>
  8117. Returns true if two <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> are exactly the same.
  8118. </summary>
  8119. <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
  8120. <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
  8121. <returns>true if the two arguments are exactly the same, false otherwise.</returns>
  8122. </member>
  8123. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_Inequality(NpgsqlTypes.NpgsqlTimeSpan,NpgsqlTypes.NpgsqlTimeSpan)">
  8124. <summary>
  8125. Returns false if two <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> are exactly the same.
  8126. </summary>
  8127. <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
  8128. <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
  8129. <returns>false if the two arguments are exactly the same, true otherwise.</returns>
  8130. </member>
  8131. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_LessThan(NpgsqlTypes.NpgsqlTimeSpan,NpgsqlTypes.NpgsqlTimeSpan)">
  8132. <summary>
  8133. Compares two <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> instances to see if the first is less than the second
  8134. </summary>
  8135. <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
  8136. <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
  8137. <returns>true if the first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> is less than second, false otherwise.</returns>
  8138. </member>
  8139. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_LessThanOrEqual(NpgsqlTypes.NpgsqlTimeSpan,NpgsqlTypes.NpgsqlTimeSpan)">
  8140. <summary>
  8141. Compares two <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> instances to see if the first is less than or equivalent to the second
  8142. </summary>
  8143. <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
  8144. <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
  8145. <returns>true if the first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> is less than or equivalent to second, false otherwise.</returns>
  8146. </member>
  8147. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_GreaterThan(NpgsqlTypes.NpgsqlTimeSpan,NpgsqlTypes.NpgsqlTimeSpan)">
  8148. <summary>
  8149. Compares two <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> instances to see if the first is greater than the second
  8150. </summary>
  8151. <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
  8152. <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
  8153. <returns>true if the first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> is greater than second, false otherwise.</returns>
  8154. </member>
  8155. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_GreaterThanOrEqual(NpgsqlTypes.NpgsqlTimeSpan,NpgsqlTypes.NpgsqlTimeSpan)">
  8156. <summary>
  8157. Compares two <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> instances to see if the first is greater than or equivalent the second
  8158. </summary>
  8159. <param name="x">The first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
  8160. <param name="y">The second <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> to compare.</param>
  8161. <returns>true if the first <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> is greater than or equivalent to the second, false otherwise.</returns>
  8162. </member>
  8163. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_UnaryPlus(NpgsqlTypes.NpgsqlTimeSpan)">
  8164. <summary>
  8165. Returns the instance.
  8166. </summary>
  8167. </member>
  8168. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.Plus(NpgsqlTypes.NpgsqlTimeSpan)">
  8169. <summary>
  8170. Returns the instance.
  8171. </summary>
  8172. </member>
  8173. <member name="M:NpgsqlTypes.NpgsqlTimeSpan.op_UnaryNegation(NpgsqlTypes.NpgsqlTimeSpan)">
  8174. <summary>
  8175. Negates an <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/> instance.
  8176. </summary>
  8177. <param name="x">An <see cref="T:NpgsqlTypes.NpgsqlTimeSpan"/>.</param>
  8178. <returns>The negation of the argument.</returns>
  8179. </member>
  8180. <member name="T:NpgsqlTypes.NpgsqlTsQuery">
  8181. <summary>
  8182. Represents a PostgreSQL tsquery. This is the base class for the
  8183. lexeme, not, or, and, and "followed by" nodes.
  8184. </summary>
  8185. </member>
  8186. <member name="P:NpgsqlTypes.NpgsqlTsQuery.Kind">
  8187. <summary>
  8188. Node kind
  8189. </summary>
  8190. </member>
  8191. <member name="T:NpgsqlTypes.NpgsqlTsQuery.NodeKind">
  8192. <summary>
  8193. NodeKind
  8194. </summary>
  8195. </member>
  8196. <member name="F:NpgsqlTypes.NpgsqlTsQuery.NodeKind.Empty">
  8197. <summary>
  8198. Represents the empty tsquery. Should only be used at top level.
  8199. </summary>
  8200. </member>
  8201. <member name="F:NpgsqlTypes.NpgsqlTsQuery.NodeKind.Lexeme">
  8202. <summary>
  8203. Lexeme
  8204. </summary>
  8205. </member>
  8206. <member name="F:NpgsqlTypes.NpgsqlTsQuery.NodeKind.Not">
  8207. <summary>
  8208. Not operator
  8209. </summary>
  8210. </member>
  8211. <member name="F:NpgsqlTypes.NpgsqlTsQuery.NodeKind.And">
  8212. <summary>
  8213. And operator
  8214. </summary>
  8215. </member>
  8216. <member name="F:NpgsqlTypes.NpgsqlTsQuery.NodeKind.Or">
  8217. <summary>
  8218. Or operator
  8219. </summary>
  8220. </member>
  8221. <member name="F:NpgsqlTypes.NpgsqlTsQuery.NodeKind.Phrase">
  8222. <summary>
  8223. "Followed by" operator
  8224. </summary>
  8225. </member>
  8226. <member name="M:NpgsqlTypes.NpgsqlTsQuery.ToString">
  8227. <summary>
  8228. Writes the tsquery in PostgreSQL's text format.
  8229. </summary>
  8230. <returns></returns>
  8231. </member>
  8232. <member name="M:NpgsqlTypes.NpgsqlTsQuery.Parse(System.String)">
  8233. <summary>
  8234. Parses a tsquery in PostgreSQL's text format.
  8235. </summary>
  8236. <param name="value"></param>
  8237. <returns></returns>
  8238. </member>
  8239. <member name="T:NpgsqlTypes.NpgsqlTsQueryLexeme">
  8240. <summary>
  8241. TsQuery Lexeme node.
  8242. </summary>
  8243. </member>
  8244. <member name="P:NpgsqlTypes.NpgsqlTsQueryLexeme.Text">
  8245. <summary>
  8246. Lexeme text.
  8247. </summary>
  8248. </member>
  8249. <member name="P:NpgsqlTypes.NpgsqlTsQueryLexeme.Weights">
  8250. <summary>
  8251. Weights is a bitmask of the Weight enum.
  8252. </summary>
  8253. </member>
  8254. <member name="P:NpgsqlTypes.NpgsqlTsQueryLexeme.IsPrefixSearch">
  8255. <summary>
  8256. Prefix search.
  8257. </summary>
  8258. </member>
  8259. <member name="M:NpgsqlTypes.NpgsqlTsQueryLexeme.#ctor(System.String)">
  8260. <summary>
  8261. Creates a tsquery lexeme with only lexeme text.
  8262. </summary>
  8263. <param name="text">Lexeme text.</param>
  8264. </member>
  8265. <member name="M:NpgsqlTypes.NpgsqlTsQueryLexeme.#ctor(System.String,NpgsqlTypes.NpgsqlTsQueryLexeme.Weight)">
  8266. <summary>
  8267. Creates a tsquery lexeme with lexeme text and weights.
  8268. </summary>
  8269. <param name="text">Lexeme text.</param>
  8270. <param name="weights">Bitmask of enum Weight.</param>
  8271. </member>
  8272. <member name="M:NpgsqlTypes.NpgsqlTsQueryLexeme.#ctor(System.String,NpgsqlTypes.NpgsqlTsQueryLexeme.Weight,System.Boolean)">
  8273. <summary>
  8274. Creates a tsquery lexeme with lexeme text, weights and prefix search flag.
  8275. </summary>
  8276. <param name="text">Lexeme text.</param>
  8277. <param name="weights">Bitmask of enum Weight.</param>
  8278. <param name="isPrefixSearch">Is prefix search?</param>
  8279. </member>
  8280. <member name="T:NpgsqlTypes.NpgsqlTsQueryLexeme.Weight">
  8281. <summary>
  8282. Weight enum, can be OR'ed together.
  8283. </summary>
  8284. </member>
  8285. <member name="F:NpgsqlTypes.NpgsqlTsQueryLexeme.Weight.None">
  8286. <summary>
  8287. None
  8288. </summary>
  8289. </member>
  8290. <member name="F:NpgsqlTypes.NpgsqlTsQueryLexeme.Weight.D">
  8291. <summary>
  8292. D
  8293. </summary>
  8294. </member>
  8295. <member name="F:NpgsqlTypes.NpgsqlTsQueryLexeme.Weight.C">
  8296. <summary>
  8297. C
  8298. </summary>
  8299. </member>
  8300. <member name="F:NpgsqlTypes.NpgsqlTsQueryLexeme.Weight.B">
  8301. <summary>
  8302. B
  8303. </summary>
  8304. </member>
  8305. <member name="F:NpgsqlTypes.NpgsqlTsQueryLexeme.Weight.A">
  8306. <summary>
  8307. A
  8308. </summary>
  8309. </member>
  8310. <member name="T:NpgsqlTypes.NpgsqlTsQueryNot">
  8311. <summary>
  8312. TsQuery Not node.
  8313. </summary>
  8314. </member>
  8315. <member name="P:NpgsqlTypes.NpgsqlTsQueryNot.Child">
  8316. <summary>
  8317. Child node
  8318. </summary>
  8319. </member>
  8320. <member name="M:NpgsqlTypes.NpgsqlTsQueryNot.#ctor(NpgsqlTypes.NpgsqlTsQuery)">
  8321. <summary>
  8322. Creates a not operator, with a given child node.
  8323. </summary>
  8324. <param name="child"></param>
  8325. </member>
  8326. <member name="T:NpgsqlTypes.NpgsqlTsQueryBinOp">
  8327. <summary>
  8328. Base class for TsQuery binary operators (&amp; and |).
  8329. </summary>
  8330. </member>
  8331. <member name="P:NpgsqlTypes.NpgsqlTsQueryBinOp.Left">
  8332. <summary>
  8333. Left child
  8334. </summary>
  8335. </member>
  8336. <member name="P:NpgsqlTypes.NpgsqlTsQueryBinOp.Right">
  8337. <summary>
  8338. Right child
  8339. </summary>
  8340. </member>
  8341. <member name="T:NpgsqlTypes.NpgsqlTsQueryAnd">
  8342. <summary>
  8343. TsQuery And node.
  8344. </summary>
  8345. </member>
  8346. <member name="M:NpgsqlTypes.NpgsqlTsQueryAnd.#ctor(NpgsqlTypes.NpgsqlTsQuery,NpgsqlTypes.NpgsqlTsQuery)">
  8347. <summary>
  8348. Creates an and operator, with two given child nodes.
  8349. </summary>
  8350. <param name="left"></param>
  8351. <param name="right"></param>
  8352. </member>
  8353. <member name="T:NpgsqlTypes.NpgsqlTsQueryOr">
  8354. <summary>
  8355. TsQuery Or Node.
  8356. </summary>
  8357. </member>
  8358. <member name="M:NpgsqlTypes.NpgsqlTsQueryOr.#ctor(NpgsqlTypes.NpgsqlTsQuery,NpgsqlTypes.NpgsqlTsQuery)">
  8359. <summary>
  8360. Creates an or operator, with two given child nodes.
  8361. </summary>
  8362. <param name="left"></param>
  8363. <param name="right"></param>
  8364. </member>
  8365. <member name="T:NpgsqlTypes.NpgsqlTsQueryFollowedBy">
  8366. <summary>
  8367. TsQuery "Followed by" Node.
  8368. </summary>
  8369. </member>
  8370. <member name="P:NpgsqlTypes.NpgsqlTsQueryFollowedBy.Distance">
  8371. <summary>
  8372. The distance between the 2 nodes, in lexemes.
  8373. </summary>
  8374. </member>
  8375. <member name="M:NpgsqlTypes.NpgsqlTsQueryFollowedBy.#ctor(NpgsqlTypes.NpgsqlTsQuery,System.Int32,NpgsqlTypes.NpgsqlTsQuery)">
  8376. <summary>
  8377. Creates a "followed by" operator, specifying 2 child nodes and the
  8378. distance between them in lexemes.
  8379. </summary>
  8380. <param name="left"></param>
  8381. <param name="distance"></param>
  8382. <param name="right"></param>
  8383. </member>
  8384. <member name="T:NpgsqlTypes.NpgsqlTsQueryEmpty">
  8385. <summary>
  8386. Represents an empty tsquery. Shold only be used as top node.
  8387. </summary>
  8388. </member>
  8389. <member name="M:NpgsqlTypes.NpgsqlTsQueryEmpty.#ctor">
  8390. <summary>
  8391. Creates a tsquery that represents an empty query. Should not be used as child node.
  8392. </summary>
  8393. </member>
  8394. <member name="T:NpgsqlTypes.NpgsqlTsVector">
  8395. <summary>
  8396. Represents a PostgreSQL tsvector.
  8397. </summary>
  8398. </member>
  8399. <member name="M:NpgsqlTypes.NpgsqlTsVector.#ctor(System.Collections.Generic.List{NpgsqlTypes.NpgsqlTsVector.Lexeme})">
  8400. <summary>
  8401. Constructs an NpgsqlTsVector from a list of lexemes. This also sorts and remove duplicates.
  8402. </summary>
  8403. <param name="lexemes"></param>
  8404. </member>
  8405. <member name="M:NpgsqlTypes.NpgsqlTsVector.Parse(System.String)">
  8406. <summary>
  8407. Parses a tsvector in PostgreSQL's text format.
  8408. </summary>
  8409. <param name="value"></param>
  8410. <returns></returns>
  8411. </member>
  8412. <member name="P:NpgsqlTypes.NpgsqlTsVector.Item(System.Int32)">
  8413. <summary>
  8414. Returns the lexeme at a specific index
  8415. </summary>
  8416. <param name="index"></param>
  8417. <returns></returns>
  8418. </member>
  8419. <member name="P:NpgsqlTypes.NpgsqlTsVector.Count">
  8420. <summary>
  8421. Gets the number of lexemes.
  8422. </summary>
  8423. </member>
  8424. <member name="M:NpgsqlTypes.NpgsqlTsVector.GetEnumerator">
  8425. <summary>
  8426. Returns an enumerator.
  8427. </summary>
  8428. <returns></returns>
  8429. </member>
  8430. <member name="M:NpgsqlTypes.NpgsqlTsVector.System#Collections#IEnumerable#GetEnumerator">
  8431. <summary>
  8432. Returns an enumerator.
  8433. </summary>
  8434. <returns></returns>
  8435. </member>
  8436. <member name="M:NpgsqlTypes.NpgsqlTsVector.ToString">
  8437. <summary>
  8438. Gets a string representation in PostgreSQL's format.
  8439. </summary>
  8440. <returns></returns>
  8441. </member>
  8442. <member name="T:NpgsqlTypes.NpgsqlTsVector.Lexeme">
  8443. <summary>
  8444. Represents a lexeme. A lexeme consists of a text string and optional word entry positions.
  8445. </summary>
  8446. </member>
  8447. <member name="P:NpgsqlTypes.NpgsqlTsVector.Lexeme.Text">
  8448. <summary>
  8449. Gets or sets the text.
  8450. </summary>
  8451. </member>
  8452. <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.#ctor(System.String)">
  8453. <summary>
  8454. Creates a lexeme with no word entry positions.
  8455. </summary>
  8456. <param name="text"></param>
  8457. </member>
  8458. <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.#ctor(System.String,System.Collections.Generic.List{NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos})">
  8459. <summary>
  8460. Creates a lexeme with word entry positions.
  8461. </summary>
  8462. <param name="text"></param>
  8463. <param name="wordEntryPositions"></param>
  8464. </member>
  8465. <member name="P:NpgsqlTypes.NpgsqlTsVector.Lexeme.Item(System.Int32)">
  8466. <summary>
  8467. Gets a word entry position.
  8468. </summary>
  8469. <param name="index"></param>
  8470. <returns></returns>
  8471. </member>
  8472. <member name="P:NpgsqlTypes.NpgsqlTsVector.Lexeme.Count">
  8473. <summary>
  8474. Gets the number of word entry positions.
  8475. </summary>
  8476. </member>
  8477. <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.ToString">
  8478. <summary>
  8479. Creates a string representation in PostgreSQL's format.
  8480. </summary>
  8481. <returns></returns>
  8482. </member>
  8483. <member name="T:NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos">
  8484. <summary>
  8485. Represents a word entry position and an optional weight.
  8486. </summary>
  8487. </member>
  8488. <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos.#ctor(System.Int32,NpgsqlTypes.NpgsqlTsVector.Lexeme.Weight)">
  8489. <summary>
  8490. Creates a WordEntryPos with a given position and weight.
  8491. </summary>
  8492. <param name="pos">Position values can range from 1 to 16383; larger numbers are silently set to 16383.</param>
  8493. <param name="weight">A weight labeled between A and D.</param>
  8494. </member>
  8495. <member name="P:NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos.Weight">
  8496. <summary>
  8497. The weight is labeled from A to D. D is the default, and not printed.
  8498. </summary>
  8499. </member>
  8500. <member name="P:NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos.Pos">
  8501. <summary>
  8502. The position is a 14-bit unsigned integer indicating the position in the text this lexeme occurs. Cannot be 0.
  8503. </summary>
  8504. </member>
  8505. <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos.ToString">
  8506. <summary>
  8507. Prints this lexeme in PostgreSQL's format, i.e. position is followed by weight (weight is only printed if A, B or C).
  8508. </summary>
  8509. <returns></returns>
  8510. </member>
  8511. <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos.Equals(NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos)">
  8512. <summary>
  8513. Determines whether the specified object is equal to the current object.
  8514. </summary>
  8515. </member>
  8516. <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos.Equals(System.Object)">
  8517. <summary>
  8518. Determines whether the specified object is equal to the current object.
  8519. </summary>
  8520. </member>
  8521. <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos.GetHashCode">
  8522. <summary>
  8523. Gets a hash code for the current object.
  8524. </summary>
  8525. </member>
  8526. <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos.op_Equality(NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos,NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos)">
  8527. <summary>
  8528. Determines whether the specified object is equal to the current object.
  8529. </summary>
  8530. </member>
  8531. <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos.op_Inequality(NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos,NpgsqlTypes.NpgsqlTsVector.Lexeme.WordEntryPos)">
  8532. <summary>
  8533. Determines whether the specified object is unequal to the current object.
  8534. </summary>
  8535. </member>
  8536. <member name="T:NpgsqlTypes.NpgsqlTsVector.Lexeme.Weight">
  8537. <summary>
  8538. The weight is labeled from A to D. D is the default, and not printed.
  8539. </summary>
  8540. </member>
  8541. <member name="F:NpgsqlTypes.NpgsqlTsVector.Lexeme.Weight.D">
  8542. <summary>
  8543. D, the default
  8544. </summary>
  8545. </member>
  8546. <member name="F:NpgsqlTypes.NpgsqlTsVector.Lexeme.Weight.C">
  8547. <summary>
  8548. C
  8549. </summary>
  8550. </member>
  8551. <member name="F:NpgsqlTypes.NpgsqlTsVector.Lexeme.Weight.B">
  8552. <summary>
  8553. B
  8554. </summary>
  8555. </member>
  8556. <member name="F:NpgsqlTypes.NpgsqlTsVector.Lexeme.Weight.A">
  8557. <summary>
  8558. A
  8559. </summary>
  8560. </member>
  8561. <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.Equals(NpgsqlTypes.NpgsqlTsVector.Lexeme)">
  8562. <summary>
  8563. Determines whether the specified object is equal to the current object.
  8564. </summary>
  8565. </member>
  8566. <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.Equals(System.Object)">
  8567. <summary>
  8568. Determines whether the specified object is equal to the current object.
  8569. </summary>
  8570. </member>
  8571. <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.GetHashCode">
  8572. <summary>
  8573. Gets a hash code for the current object.
  8574. </summary>
  8575. </member>
  8576. <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.op_Equality(NpgsqlTypes.NpgsqlTsVector.Lexeme,NpgsqlTypes.NpgsqlTsVector.Lexeme)">
  8577. <summary>
  8578. Determines whether the specified object is equal to the current object.
  8579. </summary>
  8580. </member>
  8581. <member name="M:NpgsqlTypes.NpgsqlTsVector.Lexeme.op_Inequality(NpgsqlTypes.NpgsqlTsVector.Lexeme,NpgsqlTypes.NpgsqlTsVector.Lexeme)">
  8582. <summary>
  8583. Determines whether the specified object is unequal to the current object.
  8584. </summary>
  8585. </member>
  8586. <member name="T:NpgsqlTypes.NpgsqlPoint">
  8587. <summary>
  8588. Represents a PostgreSQL point type.
  8589. </summary>
  8590. <remarks>
  8591. See http://www.postgresql.org/docs/current/static/datatype-geometric.html
  8592. </remarks>
  8593. </member>
  8594. <member name="T:NpgsqlTypes.NpgsqlLine">
  8595. <summary>
  8596. Represents a PostgreSQL line type.
  8597. </summary>
  8598. <remarks>
  8599. See http://www.postgresql.org/docs/current/static/datatype-geometric.html
  8600. </remarks>
  8601. </member>
  8602. <member name="T:NpgsqlTypes.NpgsqlLSeg">
  8603. <summary>
  8604. Represents a PostgreSQL Line Segment type.
  8605. </summary>
  8606. </member>
  8607. <member name="T:NpgsqlTypes.NpgsqlBox">
  8608. <summary>
  8609. Represents a PostgreSQL box type.
  8610. </summary>
  8611. <remarks>
  8612. See http://www.postgresql.org/docs/current/static/datatype-geometric.html
  8613. </remarks>
  8614. </member>
  8615. <member name="T:NpgsqlTypes.NpgsqlPath">
  8616. <summary>
  8617. Represents a PostgreSQL Path type.
  8618. </summary>
  8619. </member>
  8620. <member name="T:NpgsqlTypes.NpgsqlPolygon">
  8621. <summary>
  8622. Represents a PostgreSQL Polygon type.
  8623. </summary>
  8624. </member>
  8625. <member name="T:NpgsqlTypes.NpgsqlCircle">
  8626. <summary>
  8627. Represents a PostgreSQL Circle type.
  8628. </summary>
  8629. </member>
  8630. <member name="T:NpgsqlTypes.NpgsqlInet">
  8631. <summary>
  8632. Represents a PostgreSQL inet type, which is a combination of an IPAddress and a
  8633. subnet mask.
  8634. </summary>
  8635. <remarks>
  8636. http://www.postgresql.org/docs/current/static/datatype-net-types.html
  8637. </remarks>
  8638. </member>
  8639. <member name="T:NpgsqlTypes.NpgsqlTid">
  8640. <summary>
  8641. Represents a PostgreSQL tid value
  8642. </summary>
  8643. <remarks>
  8644. http://www.postgresql.org/docs/current/static/datatype-oid.html
  8645. </remarks>
  8646. </member>
  8647. <member name="P:NpgsqlTypes.NpgsqlTid.BlockNumber">
  8648. <summary>
  8649. Block number
  8650. </summary>
  8651. </member>
  8652. <member name="P:NpgsqlTypes.NpgsqlTid.OffsetNumber">
  8653. <summary>
  8654. Tuple index within block
  8655. </summary>
  8656. </member>
  8657. <member name="T:NpgsqlTypes.PgNameAttribute">
  8658. <summary>
  8659. Indicates that this property or field correspond to a PostgreSQL field with the specified name
  8660. </summary>
  8661. </member>
  8662. <member name="P:NpgsqlTypes.PgNameAttribute.PgName">
  8663. <summary>
  8664. The name of PostgreSQL field that corresponds to this CLR property or field
  8665. </summary>
  8666. </member>
  8667. <member name="M:NpgsqlTypes.PgNameAttribute.#ctor(System.String)">
  8668. <summary>
  8669. Indicates that this property or field correspond to a PostgreSQL field with the specified name
  8670. </summary>
  8671. <param name="pgName">The name of PostgreSQL field that corresponds to this CLR property or field</param>
  8672. </member>
  8673. <member name="T:JetBrains.Annotations.CanBeNullAttribute">
  8674. <summary>
  8675. Indicates that the value of the marked element could be <c>null</c> sometimes,
  8676. so the check for <c>null</c> is necessary before its usage.
  8677. </summary>
  8678. <example><code>
  8679. [CanBeNull] public object Test() { return null; }
  8680. public void UseTest() {
  8681. var p = Test();
  8682. var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
  8683. }
  8684. </code></example>
  8685. </member>
  8686. <member name="T:JetBrains.Annotations.NotNullAttribute">
  8687. <summary>
  8688. Indicates that the value of the marked element could never be <c>null</c>.
  8689. </summary>
  8690. <example><code>
  8691. [NotNull] public object Foo() {
  8692. return null; // Warning: Possible 'null' assignment
  8693. }
  8694. </code></example>
  8695. </member>
  8696. <member name="T:JetBrains.Annotations.ItemNotNullAttribute">
  8697. <summary>
  8698. Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task
  8699. and Lazy classes to indicate that the value of a collection item, of the Task.Result property
  8700. or of the Lazy.Value property can never be null.
  8701. </summary>
  8702. </member>
  8703. <member name="T:JetBrains.Annotations.ItemCanBeNullAttribute">
  8704. <summary>
  8705. Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task
  8706. and Lazy classes to indicate that the value of a collection item, of the Task.Result property
  8707. or of the Lazy.Value property can be null.
  8708. </summary>
  8709. </member>
  8710. <member name="T:JetBrains.Annotations.UsedImplicitlyAttribute">
  8711. <summary>
  8712. Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library),
  8713. so this symbol will not be marked as unused (as well as by other usage inspections).
  8714. </summary>
  8715. </member>
  8716. <member name="T:JetBrains.Annotations.MeansImplicitUseAttribute">
  8717. <summary>
  8718. Should be used on attributes and causes ReSharper to not mark symbols marked with such attributes
  8719. as unused (as well as by other usage inspections)
  8720. </summary>
  8721. </member>
  8722. <member name="F:JetBrains.Annotations.ImplicitUseKindFlags.Access">
  8723. <summary>Only entity marked with attribute considered used.</summary>
  8724. </member>
  8725. <member name="F:JetBrains.Annotations.ImplicitUseKindFlags.Assign">
  8726. <summary>Indicates implicit assignment to a member.</summary>
  8727. </member>
  8728. <member name="F:JetBrains.Annotations.ImplicitUseKindFlags.InstantiatedWithFixedConstructorSignature">
  8729. <summary>
  8730. Indicates implicit instantiation of a type with fixed constructor signature.
  8731. That means any unused constructor parameters won't be reported as such.
  8732. </summary>
  8733. </member>
  8734. <member name="F:JetBrains.Annotations.ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature">
  8735. <summary>Indicates implicit instantiation of a type.</summary>
  8736. </member>
  8737. <member name="T:JetBrains.Annotations.ImplicitUseTargetFlags">
  8738. <summary>
  8739. Specify what is considered used implicitly when marked
  8740. with <see cref="T:JetBrains.Annotations.MeansImplicitUseAttribute"/> or <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>.
  8741. </summary>
  8742. </member>
  8743. <member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.Members">
  8744. <summary>Members of entity marked with attribute are considered used.</summary>
  8745. </member>
  8746. <member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.WithMembers">
  8747. <summary>Entity marked with attribute and all its members considered used.</summary>
  8748. </member>
  8749. <member name="T:JetBrains.Annotations.PublicAPIAttribute">
  8750. <summary>
  8751. This attribute is intended to mark publicly available API
  8752. which should not be removed and so is treated as used.
  8753. </summary>
  8754. </member>
  8755. <member name="T:JetBrains.Annotations.ContractAnnotationAttribute">
  8756. <summary>
  8757. Describes dependency between method input and output.
  8758. </summary>
  8759. <syntax>
  8760. <p>Function Definition Table syntax:</p>
  8761. <list>
  8762. <item>FDT ::= FDTRow [;FDTRow]*</item>
  8763. <item>FDTRow ::= Input =&gt; Output | Output &lt;= Input</item>
  8764. <item>Input ::= ParameterName: Value [, Input]*</item>
  8765. <item>Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value}</item>
  8766. <item>Value ::= true | false | null | notnull | canbenull</item>
  8767. </list>
  8768. If method has single input parameter, it's name could be omitted.<br/>
  8769. Using <c>halt</c> (or <c>void</c>/<c>nothing</c>, which is the same)
  8770. for method output means that the methos doesn't return normally.<br/>
  8771. <c>canbenull</c> annotation is only applicable for output parameters.<br/>
  8772. You can use multiple <c>[ContractAnnotation]</c> for each FDT row,
  8773. or use single attribute with rows separated by semicolon.<br/>
  8774. </syntax>
  8775. <examples><list>
  8776. <item><code>
  8777. [ContractAnnotation("=> halt")]
  8778. public void TerminationMethod()
  8779. </code></item>
  8780. <item><code>
  8781. [ContractAnnotation("halt &lt;= condition: false")]
  8782. public void Assert(bool condition, string text) // regular assertion method
  8783. </code></item>
  8784. <item><code>
  8785. [ContractAnnotation("s:null => true")]
  8786. public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty()
  8787. </code></item>
  8788. <item><code>
  8789. // A method that returns null if the parameter is null,
  8790. // and not null if the parameter is not null
  8791. [ContractAnnotation("null => null; notnull => notnull")]
  8792. public object Transform(object data)
  8793. </code></item>
  8794. <item><code>
  8795. [ContractAnnotation("s:null=>false; =>true,result:notnull; =>false, result:null")]
  8796. public bool TryParse(string s, out Person result)
  8797. </code></item>
  8798. </list></examples>
  8799. </member>
  8800. <member name="T:JetBrains.Annotations.InvokerParameterNameAttribute">
  8801. <summary>
  8802. Indicates that the function argument should be string literal and match one
  8803. of the parameters of the caller function. For example, ReSharper annotates
  8804. the parameter of <see cref="T:System.ArgumentNullException"/>.
  8805. </summary>
  8806. <example><code>
  8807. public void Foo(string param) {
  8808. if (param == null)
  8809. throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
  8810. }
  8811. </code></example>
  8812. </member>
  8813. <member name="T:JetBrains.Annotations.NoEnumerationAttribute">
  8814. <summary>
  8815. Indicates that IEnumerable, passed as parameter, is not enumerated.
  8816. </summary>
  8817. </member>
  8818. </members>
  8819. </doc>