1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>Supabase.Postgrest</name>
- </assembly>
- <members>
- <member name="T:Supabase.Postgrest.Attributes.ColumnAttribute">
- <summary>
- Used to map a C# property to a Postgrest Column.
- </summary>
- <example>
- <code>
- class User : BaseModel {
- [ColumnName("firstName")]
- public string FirstName {get; set;}
- }
- </code>
- </example>
- </member>
- <member name="P:Supabase.Postgrest.Attributes.ColumnAttribute.ColumnName">
- <summary>
- The name in postgres of this column.
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Attributes.ColumnAttribute.NullValueHandling">
- <summary>
- Specifies what should be serialized in the event this column's value is NULL
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Attributes.ColumnAttribute.IgnoreOnInsert">
- <summary>
- If the performed query is an Insert or Upsert, should this value be ignored?
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Attributes.ColumnAttribute.IgnoreOnUpdate">
- <summary>
- If the performed query is an Update, should this value be ignored?
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Attributes.ColumnAttribute.#ctor(System.String,Newtonsoft.Json.NullValueHandling,System.Boolean,System.Boolean)">
- <inheritdoc />
- </member>
- <member name="T:Supabase.Postgrest.Attributes.PrimaryKeyAttribute">
- <summary>
- Used to map a C# property to a Postgrest PrimaryKey.
- </summary>
- <example>
- <code>
- class User : BaseModel {
- [PrimaryKey("id")]
- public string Id {get; set;}
- }
- </code>
- </example>
- </member>
- <member name="P:Supabase.Postgrest.Attributes.PrimaryKeyAttribute.ShouldInsert">
- <summary>
- Would be set to false in the event that the database handles the generation of this property.
- </summary>
- </member>
- <member name="T:Supabase.Postgrest.Attributes.ReferenceAttribute">
- <summary>
- Used to specify that a foreign key relationship exists in PostgreSQL
-
- See: https://postgrest.org/en/stable/api.html#resource-embedding
- </summary>
- </member>
- <member name="T:Supabase.Postgrest.Attributes.ReferenceAttribute.JoinType">
- <summary>
- Specifies the Join type on this reference. PostgREST only allows for a LEFT join and an INNER join.
- </summary>
- </member>
- <member name="F:Supabase.Postgrest.Attributes.ReferenceAttribute.JoinType.Inner">
- <summary>
- INNER JOIN: returns rows when there is a match on both the source and the referenced tables.
- </summary>
- </member>
- <member name="F:Supabase.Postgrest.Attributes.ReferenceAttribute.JoinType.Left">
- <summary>
- LEFT JOIN: returns all rows from the source table, even if there are no matches in the referenced table
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Attributes.ReferenceAttribute.Model">
- <summary>
- Type of the model referenced
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Attributes.ReferenceAttribute.ColumnName">
- <summary>
- Column this attribute references as specified in Postgres, DOES NOT need to be set if <see cref="P:Supabase.Postgrest.Attributes.ReferenceAttribute.ForeignKey"/> is set.
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Attributes.ReferenceAttribute.ForeignKey">
- <summary>
- The explicit SQL defined foreign key that this references.
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Attributes.ReferenceAttribute.TableName">
- <summary>
- Table name of model
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Attributes.ReferenceAttribute.Columns">
- <summary>
- Columns that exist on the model we will select from.
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Attributes.ReferenceAttribute.IgnoreOnInsert">
- <summary>
- If the performed query is an Insert or Upsert, should this value be ignored? (DEFAULT TRUE)
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Attributes.ReferenceAttribute.IgnoreOnUpdate">
- <summary>
- If the performed query is an Update, should this value be ignored? (DEFAULT TRUE)
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Attributes.ReferenceAttribute.IncludeInQuery">
- <summary>
- If Reference should automatically be included in queries on this reference. (DEFAULT TRUE)
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Attributes.ReferenceAttribute.UseInnerJoin">
- <summary>
- As to whether the query will filter top-level rows.
-
- See: https://postgrest.org/en/stable/api.html#resource-embedding
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Attributes.ReferenceAttribute.#ctor(System.Type,Supabase.Postgrest.Attributes.ReferenceAttribute.JoinType,System.Boolean,System.String,System.String)">
- <summary>Establishes a reference between two tables</summary>
- <param name="model">Model referenced</param>
- <param name="includeInQuery">Should referenced be included in queries?</param>
- <param name="joinType">Specifies the join type for this relationship</param>
- <param name="columnName">Column this attribute references as specified in Postgres, DOES NOT need to be set if <see cref="ForeignKey"/> is set.</param>
- <param name="foreignKey">Foreign Key this attribute references as specified in Postgres (only required if the model references the same table multiple times)</param>
- <exception cref="T:System.Exception"></exception>
- </member>
- <member name="M:Supabase.Postgrest.Attributes.ReferenceAttribute.#ctor(System.Type,System.Boolean,System.Boolean,System.String,System.String)">
- <summary>Establishes a reference between two tables</summary>
- <param name="model">Model referenced</param>
- <param name="includeInQuery">Should referenced be included in queries?</param>
- <param name="useInnerJoin">As to whether the query will filter top-level rows.</param>
- <param name="columnName">Column this attribute references as specified in Postgres, DOES NOT need to be set if <see cref="P:Supabase.Postgrest.Attributes.ReferenceAttribute.ForeignKey"/> is set.</param>
- <param name="foreignKey">Foreign Key this attribute references as specified in Postgres (only required if the model references the same table multiple times)</param>
- <exception cref="T:System.Exception"></exception>
- </member>
- <member name="M:Supabase.Postgrest.Attributes.ReferenceAttribute.Equals(System.Object)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Attributes.ReferenceAttribute.ParseRelationships(System.Collections.Generic.List{Supabase.Postgrest.Attributes.ReferenceAttribute})">
- <summary>
- Parses relationships that exist on this model. Called by <see cref="M:Supabase.Postgrest.Attributes.ReferenceAttribute.ParseProperties(System.Collections.Generic.List{Supabase.Postgrest.Attributes.ReferenceAttribute})"/>
- </summary>
- <param name="seenRefs"></param>
- </member>
- <member name="T:Supabase.Postgrest.Attributes.TableAttribute">
- <summary>
- Used to map a C# Model to a Postgres Table.
- </summary>
- <example>
- <code>
- [Table("user")]
- class User : BaseModel {
- [ColumnName("firstName")]
- public string FirstName {get; set;}
- }
- </code>
- </example>
- </member>
- <member name="T:Supabase.Postgrest.Client">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Client.SerializerSettings(Supabase.Postgrest.ClientOptions)">
- <summary>
- Custom Serializer resolvers and converters that will be used for encoding and decoding Postgrest JSON responses.
-
- By default, Postgrest seems to use a date format that C# and Newtonsoft do not like, so this initial
- configuration handles that.
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Client.BaseUrl">
- <inheritdoc />
- </member>
- <member name="P:Supabase.Postgrest.Client.Options">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Client.AddRequestPreparedHandler(Supabase.Postgrest.OnRequestPreparedEventHandler)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Client.RemoveRequestPreparedHandler(Supabase.Postgrest.OnRequestPreparedEventHandler)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Client.ClearRequestPreparedHandlers">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Client.AddDebugHandler(Supabase.Postgrest.Interfaces.IPostgrestDebugger.DebugEventHandler)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Client.RemoveDebugHandler(Supabase.Postgrest.Interfaces.IPostgrestDebugger.DebugEventHandler)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Client.ClearDebugHandlers">
- <inheritdoc />
- </member>
- <member name="P:Supabase.Postgrest.Client.GetHeaders">
- <summary>
- Function that can be set to return dynamic headers.
-
- Headers specified in the constructor options will ALWAYS take precedence over headers returned by this function.
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Client.#ctor(System.String,Supabase.Postgrest.ClientOptions)">
- <summary>
- Should be the first call to this class to initialize a connection with a Postgrest API Server
- </summary>
- <param name="baseUrl">Api Endpoint (ex: "http://localhost:8000"), no trailing slash required.</param>
- <param name="options">Optional client configuration.</param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Client.Table``1">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Client.Table``1(Supabase.Postgrest.Interfaces.IPostgrestCacheProvider)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Client.Rpc``1(System.String,System.Object)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Client.Rpc(System.String,System.Object)">
- <inheritdoc />
- </member>
- <member name="T:Supabase.Postgrest.ClientOptions">
- <summary>
- Options that can be passed to the Client configuration
- </summary>
- </member>
- <member name="T:Supabase.Postgrest.Constants.Operator">
- <summary>
- See: https://postgrest.org/en/v7.0.0/api.html?highlight=operators#operators
- </summary>
- </member>
- <member name="T:Supabase.Postgrest.Constants.NullPosition">
- <summary>
- See: https://postgrest.org/en/v7.0.0/api.html?highlight=nulls%20first#ordering
- </summary>
- </member>
- <member name="T:Supabase.Postgrest.Constants.CountType">
- <summary>
- See: https://postgrest.org/en/v7.0.0/api.html?highlight=count#estimated-count
- </summary>
- </member>
- <member name="T:Supabase.Postgrest.Converters.DateTimeConverter">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Converters.DateTimeConverter.CanConvert(System.Type)">
- <inheritdoc />
- </member>
- <member name="P:Supabase.Postgrest.Converters.DateTimeConverter.CanWrite">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Converters.DateTimeConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Converters.DateTimeConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
- <inheritdoc />
- </member>
- <member name="T:Supabase.Postgrest.Converters.IntArrayConverter">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Converters.IntArrayConverter.CanConvert(System.Type)">
- <inheritdoc />
- </member>
- <member name="P:Supabase.Postgrest.Converters.IntArrayConverter.CanRead">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Converters.IntArrayConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Converters.IntArrayConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
- <inheritdoc />
- </member>
- <member name="T:Supabase.Postgrest.Converters.RangeConverter">
- <summary>
- Used by Newtonsoft.Json to convert a C# range into a Postgrest range.
- </summary>
- </member>
- <member name="T:Supabase.Postgrest.Debugger">
- <summary>
- A Singleton used for debug notifications
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Debugger.Instance">
- <summary>
- Returns the Singleton Instance.
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Debugger.AddDebugHandler(Supabase.Postgrest.Interfaces.IPostgrestDebugger.DebugEventHandler)">
- <summary>
- Adds a debug listener
- </summary>
- <param name="handler"></param>
- </member>
- <member name="M:Supabase.Postgrest.Debugger.RemoveDebugHandler(Supabase.Postgrest.Interfaces.IPostgrestDebugger.DebugEventHandler)">
- <summary>
- Removes a debug handler.
- </summary>
- <param name="handler"></param>
- </member>
- <member name="M:Supabase.Postgrest.Debugger.ClearDebugHandlers">
- <summary>
- Clears debug handlers.
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Debugger.Log(System.Object,System.String,Supabase.Postgrest.Exceptions.PostgrestException)">
- <summary>
- Notifies debug listeners.
- </summary>
- <param name="sender"></param>
- <param name="message"></param>
- <param name="exception"></param>
- </member>
- <member name="T:Supabase.Postgrest.Exceptions.FailureHint">
- <summary>
- https://postgrest.org/en/v10.2/errors.html?highlight=exception#http-status-codes
- </summary>
- </member>
- <member name="T:Supabase.Postgrest.Exceptions.PostgrestException">
- <summary>
- Errors from Postgrest are wrapped by this exception
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Exceptions.PostgrestException.#ctor(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Exceptions.PostgrestException.#ctor(System.String,System.Exception)">
- <inheritdoc />
- </member>
- <member name="P:Supabase.Postgrest.Exceptions.PostgrestException.Response">
- <summary>
- The response object from Postgrest
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Exceptions.PostgrestException.Content">
- <summary>
- The content of the response object from Postgrest
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Exceptions.PostgrestException.StatusCode">
- <summary>
- The HTTP status code of the response object from Postgrest
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Exceptions.PostgrestException.Reason">
- <summary>
- Postgres client's best effort at decoding the error from the GoTrue server.
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Exceptions.PostgrestException.AddReason">
- <summary>
- Attempts to decode the error from the GoTrue server.
- </summary>
- </member>
- <member name="T:Supabase.Postgrest.Extensions.EnumExtensions">
- <summary>
- Adds functionality to get a typed Attribute attached to an enum value.
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Extensions.EnumExtensions.GetAttribute``1(System.Enum)">
- <summary>
- Gets a typed Attribute attached to an enum value.
- </summary>
- <typeparam name="T"></typeparam>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="T:Supabase.Postgrest.Extensions.RangeExtensions">
- <summary>
- Adds functionality to transform a C# Range to a Postgrest String.
-
- <see>
- <cref>https://www.postgresql.org/docs/14/rangetypes.html</cref>
- </see>
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Extensions.RangeExtensions.ToPostgresString(Supabase.Postgrest.IntRange)">
- <summary>
- Transforms a C# Range to a Postgrest String.
- </summary>
- <param name="range"></param>
- <returns></returns>
- </member>
- <member name="T:Supabase.Postgrest.Extensions.UriExtensions">
- <summary>
- Pull the instance info out of the Uri
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Extensions.UriExtensions.GetInstanceUrl(System.Uri)">
- <summary>
- Pull the instance info out of the Uri
- </summary>
- <param name="uri"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Helpers.MakeRequest``1(Supabase.Postgrest.ClientOptions,System.Net.Http.HttpMethod,System.String,Newtonsoft.Json.JsonSerializerSettings,System.Object,System.Collections.Generic.Dictionary{System.String,System.String},System.Func{System.Collections.Generic.Dictionary{System.String,System.String}},System.Threading.CancellationToken)">
- <summary>
- Helper to make a request using the defined parameters to an API Endpoint and coerce into a model.
- </summary>
- <typeparam name="T"></typeparam>
- <param name="clientOptions"></param>
- <param name="method"></param>
- <param name="url"></param>
- <param name="data"></param>
- <param name="headers"></param>
- <param name="serializerSettings"></param>
- <param name="getHeaders"></param>
- <param name="cancellationToken"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Helpers.MakeRequest(Supabase.Postgrest.ClientOptions,System.Net.Http.HttpMethod,System.String,Newtonsoft.Json.JsonSerializerSettings,System.Object,System.Collections.Generic.Dictionary{System.String,System.String},System.Threading.CancellationToken)">
- <summary>
- Helper to make a request using the defined parameters to an API Endpoint.
- </summary>
- <param name="clientOptions"></param>
- <param name="method"></param>
- <param name="url"></param>
- <param name="data"></param>
- <param name="headers"></param>
- <param name="serializerSettings"></param>
- <param name="cancellationToken"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Helpers.PrepareRequestHeaders(System.Net.Http.HttpMethod,System.Collections.Generic.Dictionary{System.String,System.String},Supabase.Postgrest.ClientOptions,System.Int32,System.Int32)">
- <summary>
- Prepares the request with appropriate HTTP headers expected by Postgrest.
- </summary>
- <param name="method"></param>
- <param name="headers"></param>
- <param name="options"></param>
- <param name="rangeFrom"></param>
- <param name="rangeTo"></param>
- <returns></returns>
- </member>
- <member name="T:Supabase.Postgrest.OnRequestPreparedEventHandler">
- <summary>
- Delegate representing the request to be sent to the remote server.
- </summary>
- </member>
- <member name="T:Supabase.Postgrest.Hooks">
- <summary>
- A internal singleton used for hooks applied to <see cref="T:Supabase.Postgrest.Client"/> and <see cref="T:Supabase.Postgrest.Table`1"/>
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Hooks.Instance">
- <summary>
- Returns the Singleton Instance.
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Hooks.AddRequestPreparedHandler(Supabase.Postgrest.OnRequestPreparedEventHandler)">
- <summary>
- Adds a handler that is called prior to a request being sent.
- </summary>
- <param name="handler"></param>
- </member>
- <member name="M:Supabase.Postgrest.Hooks.RemoveRequestPreparedHandler(Supabase.Postgrest.OnRequestPreparedEventHandler)">
- <summary>
- Removes an <see cref="T:Supabase.Postgrest.OnRequestPreparedEventHandler"/> handler.
- </summary>
- <param name="handler"></param>
- </member>
- <member name="M:Supabase.Postgrest.Hooks.ClearRequestPreparedHandlers">
- <summary>
- Clears all <see cref="T:Supabase.Postgrest.OnRequestPreparedEventHandler"/> handlers.
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Hooks.NotifyOnRequestPreparedHandlers(System.Object,Supabase.Postgrest.ClientOptions,System.Net.Http.HttpMethod,System.String,Newtonsoft.Json.JsonSerializerSettings,System.Object,System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Notifies all listeners.
- </summary>
- <param name="sender"></param>
- <param name="clientOptions"></param>
- <param name="method"></param>
- <param name="url"></param>
- <param name="serializerSettings"></param>
- <param name="data"></param>
- <param name="headers"></param>
- </member>
- <member name="T:Supabase.Postgrest.Interfaces.IPostgrestCacheProvider">
- <summary>
- A caching provider than can be used by postgrest to store requests.
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestCacheProvider.GetItem``1(System.String)">
- <summary>
- Gets an item from a caching solution, should coerce into a datatype.
-
- This will most likely be a JSON deserialization approach.
- </summary>
- <param name="key">A reproducible key for a defined query.</param>
- <typeparam name="T"></typeparam>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestCacheProvider.SetItem(System.String,System.Object)">
- <summary>
- Sets an item within a caching solution, should store in a way that the data can be retrieved and coerced into a generic type by <see cref="M:Supabase.Postgrest.Interfaces.IPostgrestCacheProvider.GetItem``1(System.String)"/>
-
- This will most likely be a JSON serialization approach.
- </summary>
- <param name="key">A reproducible key for a defined query.</param>
- <param name="value">An object of serializable data.</param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestCacheProvider.ClearItem(System.String)">
- <summary>
- Clear an item within a caching solution by a key.
- </summary>
- <param name="key">A reproducible key for a defined query.</param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestCacheProvider.Empty">
- <summary>
- An empty/clear cache implementation.
- </summary>
- <returns></returns>
- </member>
- <member name="T:Supabase.Postgrest.Interfaces.IPostgrestClient">
- <summary>
- Client interface for Postgrest
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Interfaces.IPostgrestClient.BaseUrl">
- <summary>
- API Base Url for subsequent calls.
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Interfaces.IPostgrestClient.Options">
- <summary>
- The Options <see cref="T:Supabase.Postgrest.Client"/> was initialized with.
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestClient.AddRequestPreparedHandler(Supabase.Postgrest.OnRequestPreparedEventHandler)">
- <summary>
- Adds a handler that is called prior to a request being sent.
- </summary>
- <param name="handler"></param>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestClient.RemoveRequestPreparedHandler(Supabase.Postgrest.OnRequestPreparedEventHandler)">
- <summary>
- Removes an <see cref="T:Supabase.Postgrest.OnRequestPreparedEventHandler"/> handler.
- </summary>
- <param name="handler"></param>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestClient.ClearRequestPreparedHandlers">
- <summary>
- Clears all <see cref="T:Supabase.Postgrest.OnRequestPreparedEventHandler"/> handlers.
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestClient.AddDebugHandler(Supabase.Postgrest.Interfaces.IPostgrestDebugger.DebugEventHandler)">
- <summary>
- Adds a debug handler
- </summary>
- <param name="handler"></param>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestClient.RemoveDebugHandler(Supabase.Postgrest.Interfaces.IPostgrestDebugger.DebugEventHandler)">
- <summary>
- Removes a debug handler
- </summary>
- /// <param name="handler"></param>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestClient.ClearDebugHandlers">
- <summary>
- Clears debug handlers
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestClient.Rpc(System.String,System.Object)">
- <summary>
- Perform a stored procedure call.
- </summary>
- <param name="procedureName">The function name to call</param>
- <param name="parameters">The parameters to pass to the function call</param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestClient.Rpc``1(System.String,System.Object)">
- <summary>
- Perform a stored procedure call.
- </summary>
- <param name="procedureName">The function name to call</param>
- <param name="parameters">The parameters to pass to the function call</param>
- <typeparam name="TModeledResponse">A type used for hydrating the HTTP response content (hydration through JSON.NET)</typeparam>
- <returns>A hydrated model</returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestClient.Table``1">
- <summary>
- Returns a Table Query Builder instance for a defined model - representative of `USE $TABLE`
- </summary>
- <typeparam name="T">Custom Model derived from `BaseModel`</typeparam>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestClient.Table``1(Supabase.Postgrest.Interfaces.IPostgrestCacheProvider)">
- <summary>
- Returns a Table Query Builder instance with a Cache Provider for a defined model - representative of `USE #$TABLE`
- </summary>
- <param name="cacheProvider"></param>
- <typeparam name="T"></typeparam>
- <returns></returns>
- </member>
- <member name="T:Supabase.Postgrest.Interfaces.IPostgrestDebugger">
- <summary>
- Interface for getting debug info from Postgrest
- </summary>
- </member>
- <member name="T:Supabase.Postgrest.Interfaces.IPostgrestDebugger.DebugEventHandler">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestDebugger.AddDebugHandler(Supabase.Postgrest.Interfaces.IPostgrestDebugger.DebugEventHandler)">
- <summary>
- Adds a debug handler
- </summary>
- <param name="handler"></param>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestDebugger.RemoveDebugHandler(Supabase.Postgrest.Interfaces.IPostgrestDebugger.DebugEventHandler)">
- <summary>
- Removes a debug handler
- </summary>
- <param name="handler"></param>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestDebugger.ClearDebugHandlers">
- <summary>
- Clears debug handlers
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestDebugger.Log(System.Object,System.String,Supabase.Postgrest.Exceptions.PostgrestException)">
- <summary>
- Logs a message
- </summary>
- <param name="sender"></param>
- <param name="message"></param>
- <param name="exception"></param>
- </member>
- <member name="T:Supabase.Postgrest.Interfaces.IPostgrestTable`1">
- <summary>
- Client interface for Postgrest
- </summary>
- <typeparam name="TModel"></typeparam>
- </member>
- <member name="P:Supabase.Postgrest.Interfaces.IPostgrestTable`1.BaseUrl">
- <summary>
- API Base Url for subsequent calls.
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Interfaces.IPostgrestTable`1.TableName">
- <summary>
- Name of the Table parsed by the Model.
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.GenerateUrl">
- <summary>
- Generates the encoded URL with defined query parameters that will be sent to the Postgrest API.
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.And(System.Collections.Generic.List{Supabase.Postgrest.Interfaces.IPostgrestQueryFilter})">
- <summary>
- Adds an AND Filter to the current query args.
- </summary>
- <param name="filters"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Clear">
- <summary>
- Clears currently defined query values.
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Columns(System.String[])">
- <summary>
- By using the columns query parameter it’s possible to specify the payload keys that will be inserted and ignore the rest of the payload.
-
- The rest of the JSON keys will be ignored.
- Using this also has the side-effect of being more efficient for Bulk Insert since PostgREST will not process the JSON and it’ll send it directly to PostgreSQL.
-
- See: https://postgrest.org/en/stable/api.html#specifying-columns
- </summary>
- <param name="columns"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Columns(System.Linq.Expressions.Expression{System.Func{`0,System.Object[]}})">
- <summary>
- By using the columns query parameter it’s possible to specify the payload keys that will be inserted and ignore the rest of the payload.
-
- The rest of the JSON keys will be ignored.
- Using this also has the side-effect of being more efficient for Bulk Insert since PostgREST will not process the JSON and it’ll send it directly to PostgreSQL.
-
- See: https://postgrest.org/en/stable/api.html#specifying-columns
- </summary>
- <param name="predicate"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Count(Supabase.Postgrest.Constants.CountType,System.Threading.CancellationToken)">
- <summary>
- Returns ONLY a count from the specified query.
-
- See: https://postgrest.org/en/v7.0.0/api.html?highlight=count
- </summary>
- <param name="type">The kind of count.</param>
- <param name="cancellationToken"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Delete(Supabase.Postgrest.QueryOptions,System.Threading.CancellationToken)">
- <summary>
- Executes a delete request using the defined query params on the current instance.
- </summary>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Delete(`0,Supabase.Postgrest.QueryOptions,System.Threading.CancellationToken)">
- <summary>
- Executes a delete request using the model's primary key as the filter for the request.
- </summary>
- <param name="model"></param>
- <param name="options"></param>
- <param name="cancellationToken"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Filter``1(System.String,Supabase.Postgrest.Constants.Operator,``0)">
- <summary>
- Add a Filter to a query request
- </summary>
- <param name="columnName">Column Name in Table.</param>
- <param name="op">Operation to perform.</param>
- <param name="criterion">Value to filter with, must be a `string`, `List<object>`, `Dictionary<string, object>`, `FullTextSearchConfig`, or `Range`</param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Filter``1(System.Linq.Expressions.Expression{System.Func{`0,System.Object}},Supabase.Postgrest.Constants.Operator,``0)">
- <summary>
- Add a filter to a query request using a predicate to select column.
- </summary>
- <param name="predicate">Expects a columns from the Model to be returned</param>
- <param name="op">Operation to perform.</param>
- <param name="criterion">Value to filter with, must be a `string`, `List<object>`, `Dictionary<string, object>`, `FullTextSearchConfig`, or `Range`</param>
- <returns></returns>
- <exception cref="T:System.ArgumentException"></exception>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Get(System.Threading.CancellationToken)">
- <summary>
- Executes the query using the defined filters on the current instance.
- </summary>
- <param name="cancellationToken"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Insert(System.Collections.Generic.ICollection{`0},Supabase.Postgrest.QueryOptions,System.Threading.CancellationToken)">
- <summary>
- Executes a BULK INSERT query using the defined query params on the current instance.
- </summary>
- <param name="models"></param>
- <param name="options"></param>
- <param name="cancellationToken"></param>
- <returns>A typed model response from the database.</returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Insert(`0,Supabase.Postgrest.QueryOptions,System.Threading.CancellationToken)">
- <summary>
- Executes an INSERT query using the defined query params on the current instance.
- </summary>
- <param name="model"></param>
- <param name="options"></param>
- <param name="cancellationToken"></param>
- <returns>A typed model response from the database.</returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Limit(System.Int32,System.String)">
- <summary>
- Sets a limit with an optional foreign table reference.
- </summary>
- <param name="limit"></param>
- <param name="foreignTableName"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Match(System.Collections.Generic.Dictionary{System.String,System.String})">
- <summary>
- Finds all rows whose columns match the specified `query` object.
- </summary>
- <param name="query">The object to filter with, with column names as keys mapped to their filter values.</param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Match(`0)">
- <summary>
- Fills in query parameters based on a given model's primary key(s).
- </summary>
- <param name="model">A model with a primary key column</param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Not(Supabase.Postgrest.Interfaces.IPostgrestQueryFilter)">
- <summary>
- Adds a NOT filter to the current query args.
- </summary>
- <param name="filter"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Not(System.String,Supabase.Postgrest.Constants.Operator,System.Collections.Generic.Dictionary{System.String,System.Object})">
- <summary>
- Adds a NOT filter to the current query args.
- </summary>
- <param name="columnName"></param>
- <param name="op"></param>
- <param name="criteria"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Not(System.Linq.Expressions.Expression{System.Func{`0,System.Object}},Supabase.Postgrest.Constants.Operator,System.Collections.Generic.Dictionary{System.String,System.Object})">
- <summary>
- Adds a NOT filter to the current query args.
- </summary>
- <param name="predicate">Expects a column from the model to be returned.</param>
- <param name="op"></param>
- <param name="criteria"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Not``1(System.String,Supabase.Postgrest.Constants.Operator,System.Collections.Generic.List{``0})">
- <summary>
- Adds a NOT filter to the current query args.
- Allows queries like:
- <code>
- await client.Table<User>().Not("status", Operators.In, new List<string> {"AWAY", "OFFLINE"}).Get();
- </code>
- </summary>
- <param name="columnName"></param>
- <param name="op"></param>
- <param name="criteria"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Not``1(System.Linq.Expressions.Expression{System.Func{`0,System.Object}},Supabase.Postgrest.Constants.Operator,System.Collections.Generic.List{``0})">
- <summary>
- Adds a NOT filter to the current query args.
- Allows queries like:
- <code>
- await client.Table<User>().Not("status", Operators.In, new List<string> {"AWAY", "OFFLINE"}).Get();
- </code>
- </summary>
- <param name="predicate">Expects a column from the model to be returned.</param>
- <param name="op"></param>
- <param name="criteria"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Not``1(System.String,Supabase.Postgrest.Constants.Operator,``0)">
- <summary>
- Adds a NOT filter to the current query args.
-
- Allows queries like:
- <code>
- await client.Table<User>().Not("status", Operators.Equal, "OFFLINE").Get();
- </code>
- </summary>
- <param name="columnName"></param>
- <param name="op"></param>
- <param name="criterion"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Not``1(System.Linq.Expressions.Expression{System.Func{`0,System.Object}},Supabase.Postgrest.Constants.Operator,``0)">
- <summary>
- Adds a NOT filter to the current query args.
-
- Allows queries like:
- <code>
- await client.Table<User>().Not("status", Operators.Equal, "OFFLINE").Get();
- </code>
- </summary>
- <param name="predicate">Expects a column from the model to be returned.</param>
- <param name="op"></param>
- <param name="criterion"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Offset(System.Int32,System.String)">
- <summary>
- Sets an offset with an optional foreign table reference.
- </summary>
- <param name="offset"></param>
- <param name="foreignTableName"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.OnConflict(System.String)">
- <summary>
- By specifying the onConflict query parameter, you can make UPSERT work on a column(s) that has a UNIQUE constraint.
- </summary>
- <param name="columnName"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.OnConflict(System.Linq.Expressions.Expression{System.Func{`0,System.Object}})">
- <summary>
- Set an onConflict query parameter for UPSERTing on a column that has a UNIQUE constraint using a linq predicate.
- </summary>
- <param name="predicate">Expects a column from the model to be returned.</param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Or(System.Collections.Generic.List{Supabase.Postgrest.Interfaces.IPostgrestQueryFilter})">
- <summary>
- Adds a OR Filter to the current query args.
- </summary>
- <param name="filters"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Order(System.String,Supabase.Postgrest.Constants.Ordering,Supabase.Postgrest.Constants.NullPosition)">
- <summary>
- Adds an ordering to the current query args.
-
- NOTE: If multiple orderings are required, chain this function with another call to <see>
- <cref>Order(Expression{Func{T,object}},Ordering,NullPosition)</cref>
- </see>
- .
- </summary>
- <param name="column">Column Name</param>
- <param name="ordering"></param>
- <param name="nullPosition"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Order(System.Linq.Expressions.Expression{System.Func{`0,System.Object}},Supabase.Postgrest.Constants.Ordering,Supabase.Postgrest.Constants.NullPosition)">
- <summary>
- Adds an ordering to the current query args using a predicate function.
-
- NOTE: If multiple orderings are required, chain this function with another call to <see>
- <cref>Order(Expression{Func{T,object}},Ordering,NullPosition)</cref>
- </see>
- .
- </summary>
- <param name="predicate"></param>
- <param name="ordering">>Expects a columns from the Model to be returned</param>
- <param name="nullPosition"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Order(System.String,System.String,Supabase.Postgrest.Constants.Ordering,Supabase.Postgrest.Constants.NullPosition)">
- <summary>
- Adds an ordering to the current query args.
-
- NOTE: If multiple orderings are required, chain this function with another call to <see>
- <cref>Order(Expression{Func{T,object}},Ordering,NullPosition)</cref>
- </see>
- .
- </summary>
- <param name="foreignTable"></param>
- <param name="column"></param>
- <param name="ordering"></param>
- <param name="nullPosition"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Range(System.Int32)">
- <summary>
- Sets a FROM range, similar to a `StartAt` query.
- </summary>
- <param name="from"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Range(System.Int32,System.Int32)">
- <summary>
- Sets a bounded range to the current query.
- </summary>
- <param name="from"></param>
- <param name="to"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Select(System.String)">
- <summary>
- Select columns for query.
- </summary>
- <param name="columnQuery"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Select(System.Linq.Expressions.Expression{System.Func{`0,System.Object[]}})">
- <summary>
- Select columns using a predicate function.
-
- For example:
- `Table<Movie>().Select(x => new[] { x.Id, x.Name, x.CreatedAt }).Get();`
- </summary>
- <param name="predicate">Expects an array of columns from the Model to be returned.</param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Where(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}})">
- <summary>
- Filter a query based on a predicate function.
-
- Note: Chaining multiple <see cref="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Where(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}})"/> calls will
- be parsed as an "AND" query.
-
- Examples:
- `Table<Movie>().Where(x => x.Name == "Top Gun").Get();`
- `Table<Movie>().Where(x => x.Name == "Top Gun" || x.Name == "Mad Max").Get();`
- `Table<Movie>().Where(x => x.Name.Contains("Gun")).Get();`
- `Table<Movie>().Where(x => x.CreatedAt <= new DateTime(2022, 08, 21)).Get();`
- `Table<Movie>().Where(x => x.Id > 5 && x.Name.Contains("Max")).Get();`
- </summary>
- <param name="predicate"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Single(System.Threading.CancellationToken)">
- <summary>
- Executes a query that expects to have a single object returned, rather than returning list of models
- it will return a single model.
- </summary>
- <param name="cancellationToken"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Set(System.Linq.Expressions.Expression{System.Func{`0,System.Object}},System.Object)">
- <summary>
- Specifies a key and value to be updated. Should be combined with filters/where clauses.
-
- Can be called multiple times to set multiple values.
- </summary>
- <param name="keySelector"></param>
- <param name="value"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Set(System.Linq.Expressions.Expression{System.Func{`0,System.Collections.Generic.KeyValuePair{System.Object,System.Object}}})">
- <summary>
- Specifies a KeyValuePair to be updated. Should be combined with filters/where clauses.
-
- Can be called multiple times to set multiple values.
- </summary>
- <param name="keyValuePairExpression"></param>
- <returns></returns>
- <exception cref="T:System.ArgumentException"></exception>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Update(Supabase.Postgrest.QueryOptions,System.Threading.CancellationToken)">
- <summary>
- Calls an Update function after `Set` has been called.
- </summary>
- <param name="options"></param>
- <param name="cancellationToken"></param>
- <returns></returns>
- <exception cref="T:System.ArgumentException"></exception>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Update(`0,Supabase.Postgrest.QueryOptions,System.Threading.CancellationToken)">
- <summary>
- Executes an UPDATE query using the defined query params on the current instance.
- </summary>
- <param name="model"></param>
- <param name="options"></param>
- <param name="cancellationToken"></param>
- <returns>A typed response from the database.</returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Upsert(System.Collections.Generic.ICollection{`0},Supabase.Postgrest.QueryOptions,System.Threading.CancellationToken)">
- <summary>
- Executes an UPSERT query using the defined query params on the current instance.
-
- By default the new record is returned. Set QueryOptions.ReturnType to Minimal if you don't need this value.
- By specifying the QueryOptions.OnConflict parameter, you can make UPSERT work on a column(s) that has a UNIQUE constraint.
- QueryOptions.DuplicateResolution.IgnoreDuplicates Specifies if duplicate rows should be ignored and not inserted.
- </summary>
- <param name="model"></param>
- <param name="options"></param>
- <param name="cancellationToken"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTable`1.Upsert(`0,Supabase.Postgrest.QueryOptions,System.Threading.CancellationToken)">
- <summary>
- Executes an UPSERT query using the defined query params on the current instance.
-
- By default the new record is returned. Set QueryOptions.ReturnType to Minimal if you don't need this value.
- By specifying the QueryOptions.OnConflict parameter, you can make UPSERT work on a column(s) that has a UNIQUE constraint.
- QueryOptions.DuplicateResolution.IgnoreDuplicates Specifies if duplicate rows should be ignored and not inserted.
- </summary>
- <param name="model"></param>
- <param name="options"></param>
- <param name="cancellationToken"></param>
- <returns></returns>
- </member>
- <member name="T:Supabase.Postgrest.Interfaces.IPostgrestTableWithCache`1">
- <summary>
- Client interface for Postgrest
- </summary>
- <typeparam name="T"></typeparam>
- </member>
- <member name="M:Supabase.Postgrest.Interfaces.IPostgrestTableWithCache`1.Get(System.Threading.CancellationToken)">
- <summary>
- Performs a Get request, returning a <see cref="T:Supabase.Postgrest.Requests.CacheBackedRequest`1"/> which populates from the cache, if applicable.
- </summary>
- <param name="cancellationToken"></param>
- <returns></returns>
- </member>
- <member name="T:Supabase.Postgrest.Index">
- <summary>Represent a type can be used to index a collection either from the start or the end.</summary>
- <remarks>
- Index is used by the C# compiler to support the new index syntax
- <code>
- int[] someArray = new int[5] { 1, 2, 3, 4, 5 } ;
- int lastElement = someArray[^1]; // lastElement = 5
- </code>
- </remarks>
- </member>
- <member name="M:Supabase.Postgrest.Index.#ctor(System.Int32,System.Boolean)">
- <summary>Construct an Index using a value and indicating if the index is from the start or from the end.</summary>
- <param name="value">The index value. it has to be zero or positive number.</param>
- <param name="fromEnd">Indicating if the index is from the start or from the end.</param>
- <remarks>
- If the Index constructed from the end, index value 1 means pointing at the last element and index value 0 means pointing at beyond last element.
- </remarks>
- </member>
- <member name="P:Supabase.Postgrest.Index.Start">
- <summary>Create an Index pointing at first element.</summary>
- </member>
- <member name="P:Supabase.Postgrest.Index.End">
- <summary>Create an Index pointing at beyond last element.</summary>
- </member>
- <member name="M:Supabase.Postgrest.Index.FromStart(System.Int32)">
- <summary>Create an Index from the start at the position indicated by the value.</summary>
- <param name="value">The index value from the start.</param>
- </member>
- <member name="M:Supabase.Postgrest.Index.FromEnd(System.Int32)">
- <summary>Create an Index from the end at the position indicated by the value.</summary>
- <param name="value">The index value from the end.</param>
- </member>
- <member name="P:Supabase.Postgrest.Index.Value">
- <summary>Returns the index value.</summary>
- </member>
- <member name="P:Supabase.Postgrest.Index.IsFromEnd">
- <summary>Indicates whether the index is from the start or the end.</summary>
- </member>
- <member name="M:Supabase.Postgrest.Index.GetOffset(System.Int32)">
- <summary>Calculate the offset from the start using the giving collection length.</summary>
- <param name="length">The length of the collection that the Index will be used with. length has to be a positive value</param>
- <remarks>
- For performance reason, we don't validate the input length parameter and the returned offset value against negative values.
- we don't validate either the returned offset is greater than the input length.
- It is expected Index will be used with collections which always have non negative length/count. If the returned offset is negative and
- then used to index a collection will get out of range exception which will be same affect as the validation.
- </remarks>
- </member>
- <member name="M:Supabase.Postgrest.Index.Equals(System.Object)">
- <summary>Indicates whether the current Index object is equal to another object of the same type.</summary>
- <param name="value">An object to compare with this object</param>
- </member>
- <member name="M:Supabase.Postgrest.Index.Equals(Supabase.Postgrest.Index)">
- <summary>Indicates whether the current Index object is equal to another Index object.</summary>
- <param name="other">An object to compare with this object</param>
- </member>
- <member name="M:Supabase.Postgrest.Index.GetHashCode">
- <summary>Returns the hash code for this instance.</summary>
- </member>
- <member name="M:Supabase.Postgrest.Index.op_Implicit(System.Int32)~Supabase.Postgrest.Index">
- <summary>Converts integer number to an Index.</summary>
- </member>
- <member name="M:Supabase.Postgrest.Index.ToString">
- <summary>Converts the value of the current Index object to its equivalent string representation.</summary>
- </member>
- <member name="T:Supabase.Postgrest.IntRange">
- <summary>Represent a range has start and end indexes.</summary>
- <remarks>
- Range is used by the C# compiler to support the range syntax.
- <code>
- int[] someArray = new int[5] { 1, 2, 3, 4, 5 };
- int[] subArray1 = someArray[0..2]; // { 1, 2 }
- int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 }
- </code>
- </remarks>
- </member>
- <member name="P:Supabase.Postgrest.IntRange.Start">
- <summary>Represent the inclusive start index of the Range.</summary>
- </member>
- <member name="P:Supabase.Postgrest.IntRange.End">
- <summary>Represent the exclusive end index of the Range.</summary>
- </member>
- <member name="M:Supabase.Postgrest.IntRange.#ctor(Supabase.Postgrest.Index,Supabase.Postgrest.Index)">
- <summary>Construct a Range object using the start and end indexes.</summary>
- <param name="start">Represent the inclusive start index of the range.</param>
- <param name="end">Represent the exclusive end index of the range.</param>
- </member>
- <member name="M:Supabase.Postgrest.IntRange.Equals(System.Object)">
- <summary>Indicates whether the current Range object is equal to another object of the same type.</summary>
- <param name="value">An object to compare with this object</param>
- </member>
- <member name="M:Supabase.Postgrest.IntRange.Equals(Supabase.Postgrest.IntRange)">
- <summary>Indicates whether the current Range object is equal to another Range object.</summary>
- <param name="other">An object to compare with this object</param>
- </member>
- <member name="M:Supabase.Postgrest.IntRange.GetHashCode">
- <summary>Returns the hash code for this instance.</summary>
- </member>
- <member name="M:Supabase.Postgrest.IntRange.ToString">
- <summary>Converts the value of the current Range object to its equivalent string representation.</summary>
- </member>
- <member name="M:Supabase.Postgrest.IntRange.StartAt(Supabase.Postgrest.Index)">
- <summary>Create a Range object starting from start index to the end of the collection.</summary>
- </member>
- <member name="M:Supabase.Postgrest.IntRange.EndAt(Supabase.Postgrest.Index)">
- <summary>Create a Range object starting from first element in the collection to the end Index.</summary>
- </member>
- <member name="P:Supabase.Postgrest.IntRange.All">
- <summary>Create a Range object starting from first element to the end.</summary>
- </member>
- <member name="M:Supabase.Postgrest.IntRange.GetOffsetAndLength(System.Int32)">
- <summary>Calculate the start offset and length of range object using a collection length.</summary>
- <param name="length">The length of the collection that the range will be used with. length has to be a positive value.</param>
- <remarks>
- For performance reason, we don't validate the input length parameter against negative values.
- It is expected Range will be used with collections which always have non negative length/count.
- We validate the range is inside the length scope though.
- </remarks>
- </member>
- <member name="T:Supabase.Postgrest.Linq.SelectExpressionVisitor">
- <summary>
- Helper class for parsing Select linq queries.
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Linq.SelectExpressionVisitor.Columns">
- <summary>
- The columns that have been selected from this linq expression.
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Linq.SelectExpressionVisitor.VisitNewArray(System.Linq.Expressions.NewArrayExpression)">
- <summary>
- The root call that will be looped through to populate <see cref="P:Supabase.Postgrest.Linq.SelectExpressionVisitor.Columns"/>.
-
- Called like: `Table<Movies>().Select(x => new[] { x.Id, x.Name, x.CreatedAt }).Get()`
- </summary>
- <param name="node"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Linq.SelectExpressionVisitor.VisitMember(System.Linq.Expressions.MemberExpression)">
- <summary>
- A Member Node, representing a property on a BaseModel.
- </summary>
- <param name="node"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Linq.SelectExpressionVisitor.VisitUnary(System.Linq.Expressions.UnaryExpression)">
- <summary>
- A Unary Node, delved into to represent a property on a BaseModel.
- </summary>
- <param name="node"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Linq.SelectExpressionVisitor.GetColumnFromMemberExpression(System.Linq.Expressions.MemberExpression)">
- <summary>
- Gets a column name from property based on it's supplied attributes.
- </summary>
- <param name="node"></param>
- <returns></returns>
- </member>
- <member name="T:Supabase.Postgrest.Linq.SetExpressionVisitor">
- <summary>
- Helper class for parsing Set linq queries.
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Linq.SetExpressionVisitor.Column">
- <summary>
- The column that have been selected from this linq expression.
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Linq.SetExpressionVisitor.ExpectedType">
- <summary>
- The Column's type that value should be checked against.
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Linq.SetExpressionVisitor.Value">
- <summary>
- Value to be updated.
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Linq.SetExpressionVisitor.VisitUnary(System.Linq.Expressions.UnaryExpression)">
- <summary>
- A Unary Node, delved into to represent a property on a BaseModel.
- </summary>
- <param name="node"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Linq.SetExpressionVisitor.VisitMember(System.Linq.Expressions.MemberExpression)">
- <summary>
- A Member Node, representing a property on a BaseModel.
- </summary>
- <param name="node"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Linq.SetExpressionVisitor.VisitNew(System.Linq.Expressions.NewExpression)">
- <summary>
- Called when visiting a the expected new KeyValuePair().
- </summary>
- <param name="node"></param>
- <returns></returns>
- <exception cref="T:System.ArgumentException"></exception>
- </member>
- <member name="M:Supabase.Postgrest.Linq.SetExpressionVisitor.GetColumnFromMemberExpression(System.Linq.Expressions.MemberExpression)">
- <summary>
- Gets a column name from property based on it's supplied attributes.
- </summary>
- <param name="node"></param>
- <returns></returns>
- </member>
- <member name="T:Supabase.Postgrest.Linq.WhereExpressionVisitor">
- <summary>
- Helper class for parsing Where linq queries.
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Linq.WhereExpressionVisitor.Filter">
- <summary>
- The filter resulting from this Visitor, capable of producing nested filters.
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Linq.WhereExpressionVisitor.VisitBinary(System.Linq.Expressions.BinaryExpression)">
- <summary>
- An entry point that will be used to populate <see cref="P:Supabase.Postgrest.Linq.WhereExpressionVisitor.Filter"/>.
-
- Invoked like:
- `Table<Movies>().Where(x => x.Name == "Top Gun").Get();`
- </summary>
- <param name="node"></param>
- <returns></returns>
- <exception cref="T:System.ArgumentException"></exception>
- </member>
- <member name="M:Supabase.Postgrest.Linq.WhereExpressionVisitor.VisitMethodCall(System.Linq.Expressions.MethodCallExpression)">
- <summary>
- Called when evaluating a method
- </summary>
- <param name="node"></param>
- <returns></returns>
- <exception cref="T:System.ArgumentException"></exception>
- <exception cref="T:System.NotImplementedException"></exception>
- </member>
- <member name="M:Supabase.Postgrest.Linq.WhereExpressionVisitor.HandleConstantExpression(System.String,Supabase.Postgrest.Constants.Operator,System.Linq.Expressions.ConstantExpression)">
- <summary>
- A constant expression parser (i.e. x => x.Id == 5 <- where '5' is the constant)
- </summary>
- <param name="column"></param>
- <param name="op"></param>
- <param name="constantExpression"></param>
- </member>
- <member name="M:Supabase.Postgrest.Linq.WhereExpressionVisitor.HandleMemberExpression(System.String,Supabase.Postgrest.Constants.Operator,System.Linq.Expressions.MemberExpression)">
- <summary>
- A member expression parser (i.e. => x.Id == Example.Id <- where both `x.Id` and `Example.Id` are parsed as 'members')
- </summary>
- <param name="column"></param>
- <param name="op"></param>
- <param name="memberExpression"></param>
- </member>
- <member name="M:Supabase.Postgrest.Linq.WhereExpressionVisitor.HandleUnaryExpression(System.String,Supabase.Postgrest.Constants.Operator,System.Linq.Expressions.UnaryExpression)">
- <summary>
- A unary expression parser (i.e. => x.Id == 1 <- where both `1` is considered unary)
- </summary>
- <param name="column"></param>
- <param name="op"></param>
- <param name="unaryExpression"></param>
- </member>
- <member name="M:Supabase.Postgrest.Linq.WhereExpressionVisitor.HandleNewExpression(System.String,Supabase.Postgrest.Constants.Operator,System.Linq.Expressions.NewExpression)">
- <summary>
- An instantiated class parser (i.e. x => x.CreatedAt <= new DateTime(2022, 08, 20) <- where `new DateTime(...)` is an instantiated expression.
- </summary>
- <param name="column"></param>
- <param name="op"></param>
- <param name="newExpression"></param>
- </member>
- <member name="M:Supabase.Postgrest.Linq.WhereExpressionVisitor.GetColumnFromMemberExpression(System.Linq.Expressions.MemberExpression)">
- <summary>
- Gets a column name (postgrest) from a Member Expression (used on BaseModel)
- </summary>
- <param name="node"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Linq.WhereExpressionVisitor.GetMemberExpressionValue(System.Linq.Expressions.MemberExpression)">
- <summary>
- Get the value from a MemberExpression, which includes both fields and properties.
- </summary>
- <param name="member"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Linq.WhereExpressionVisitor.GetMappedOperator(System.Linq.Expressions.Expression)">
- <summary>
- Creates map between linq <see cref="T:System.Linq.Expressions.ExpressionType"/> and <see cref="T:Supabase.Postgrest.Constants.Operator"/>
- </summary>
- <param name="node"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Linq.WhereExpressionVisitor.GetArgumentValues(System.Linq.Expressions.MethodCallExpression)">
- <summary>
- Gets arguments from a method call expression, (i.e. x => x.Name.Contains("Top")) <- where `Top` is the argument on the called method `Contains`
- </summary>
- <param name="methodCall"></param>
- <returns></returns>
- </member>
- <member name="T:Supabase.Postgrest.Models.BaseModel">
- <summary>
- Abstract class that must be implemented by C# Postgrest Models.
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Models.BaseModel.PrimaryKey">
- <summary>
- Gets the values of the PrimaryKey columns (there can be multiple) on a model's instance as defined by the [PrimaryKey] attributes on a property on the model.
- </summary>
- </member>
- <member name="T:Supabase.Postgrest.Models.CachedModel`1">
- <summary>
- Represents a cacheable model
- </summary>
- <typeparam name="TModel"></typeparam>
- </member>
- <member name="P:Supabase.Postgrest.Models.CachedModel`1.Models">
- <summary>
- The stored Models
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Models.CachedModel`1.CachedAt">
- <summary>
- Cache time in UTC.
- </summary>
- </member>
- <member name="T:Supabase.Postgrest.PostgrestContractResolver">
- <summary>
- A custom resolver that handles mapping column names and property names as well
- as handling the conversion of Postgrest Ranges to a C# `Range`.
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.PostgrestContractResolver.SetState(System.Boolean,System.Boolean,System.Boolean)">
- <summary>
- Sets the state of the contract resolver to either insert, update, or upsert.
- </summary>
- <param name="isInsert"></param>
- <param name="isUpdate"></param>
- <param name="isUpsert"></param>
- </member>
- <member name="M:Supabase.Postgrest.PostgrestContractResolver.CreateProperty(System.Reflection.MemberInfo,Newtonsoft.Json.MemberSerialization)">
- <inheritdoc />
- </member>
- <member name="T:Supabase.Postgrest.QueryFilter`2">
- <summary>
- Allow for the expression of a query filter with linq expressions.
- </summary>
- <typeparam name="TModel"></typeparam>
- <typeparam name="TCriterion"></typeparam>
- </member>
- <member name="P:Supabase.Postgrest.QueryFilter`2.Criteria">
- <inheritdoc />
- </member>
- <member name="P:Supabase.Postgrest.QueryFilter`2.Op">
- <inheritdoc />
- </member>
- <member name="P:Supabase.Postgrest.QueryFilter`2.Property">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.QueryFilter`2.#ctor(System.Linq.Expressions.Expression{System.Func{`0,System.Object}},Supabase.Postgrest.Constants.Operator,`1)">
- <summary>
- Allows the creation of a Query Filter using a LINQ expression.
- </summary>
- <param name="predicate"></param>
- <param name="op"></param>
- <param name="criterion"></param>
- <exception cref="T:System.ArgumentException"></exception>
- </member>
- <member name="T:Supabase.Postgrest.QueryFilter">
- <inheritdoc />
- </member>
- <member name="F:Supabase.Postgrest.QueryFilter.NullVal">
- <summary>
- String value to be substituted for a null criterion
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.QueryFilter.Property">
- <inheritdoc />
- </member>
- <member name="P:Supabase.Postgrest.QueryFilter.Op">
- <inheritdoc />
- </member>
- <member name="P:Supabase.Postgrest.QueryFilter.Criteria">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.QueryFilter.#ctor(System.String,Supabase.Postgrest.Constants.Operator,System.Object)">
- <summary>
- Contractor to use single value filtering.
- </summary>
- <param name="property">Column name</param>
- <param name="op">Operation: And, Equals, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, NotEqual, Is, Adjacent, Not, Like, ILike</param>
- <param name="criteria"></param>
- </member>
- <member name="M:Supabase.Postgrest.QueryFilter.#ctor(System.String,Supabase.Postgrest.Constants.Operator,Supabase.Postgrest.FullTextSearchConfig)">
- <summary>
- Constructor for Full Text Search.
- </summary>
- <param name="property">Column Name</param>
- <param name="op">Operation: FTS, PHFTS, PLFTS, WFTS</param>
- <param name="fullTextSearchConfig"></param>
- </member>
- <member name="M:Supabase.Postgrest.QueryFilter.#ctor(System.String,Supabase.Postgrest.Constants.Operator,Supabase.Postgrest.IntRange)">
- <summary>
- Constructor for Range Queries.
- </summary>
- <param name="property"></param>
- <param name="op">Operator: Overlap, StrictlyLeft, StrictlyRight, NotRightOf, NotLeftOf, Adjacent</param>
- <param name="range"></param>
- </member>
- <member name="M:Supabase.Postgrest.QueryFilter.#ctor(Supabase.Postgrest.Constants.Operator,System.Collections.Generic.List{Supabase.Postgrest.Interfaces.IPostgrestQueryFilter})">
- <summary>
- Constructor to enable `AND` and `OR` Queries by allowing nested QueryFilters.
- </summary>
- <param name="op">Operation: And, Or</param>
- <param name="filters"></param>
- </member>
- <member name="M:Supabase.Postgrest.QueryFilter.#ctor(Supabase.Postgrest.Constants.Operator,Supabase.Postgrest.Interfaces.IPostgrestQueryFilter)">
- <summary>
- Constructor to enable `NOT` functionality
- </summary>
- <param name="op">Operation: Not.</param>
- <param name="filter"></param>
- </member>
- <member name="T:Supabase.Postgrest.FullTextSearchConfig">
- <summary>
- Configuration Object for Full Text Search.
- API Reference: http://postgrest.org/en/v7.0.0/api.html?highlight=full%20text%20search#full-text-search
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.FullTextSearchConfig.QueryText">
- <summary>
- Query Text
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.FullTextSearchConfig.Config">
- <summary>
- Defaults to english
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.FullTextSearchConfig.#ctor(System.String,System.String)">
- <summary>
- Constructor for Full Text Search.
- </summary>
- <param name="queryText"></param>
- <param name="config"></param>
- </member>
- <member name="P:Supabase.Postgrest.QueryOptions.Returning">
- <summary>
- By default the new record is returned. Set this to 'Minimal' if you don't need this value.
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.QueryOptions.DuplicateResolution">
- <summary>
- Specifies if duplicate rows should be ignored and not inserted.
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.QueryOptions.Count">
- <summary>
- Count algorithm to use to count rows in a table.
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.QueryOptions.Upsert">
- <summary>
- If the record should be upserted
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.QueryOptions.OnConflict">
- <summary>
- /// By specifying the onConflict query parameter, you can make UPSERT work on a column(s) that has a UNIQUE constraint.
- </summary>
- </member>
- <member name="T:Supabase.Postgrest.Requests.CacheBackedRequest`1">
- <summary>
- Represents a Request that is backed by a caching strategy.
- </summary>
- <typeparam name="TModel"></typeparam>
- </member>
- <member name="T:Supabase.Postgrest.Requests.CacheBackedRequest`1.RemoteModelsPopulatedEventHandler">
- <summary>
- Handler for when Remote Models have been populated
- </summary>
- </member>
- <member name="F:Supabase.Postgrest.Requests.CacheBackedRequest`1._remoteRequestAction">
- <summary>
- The Async action that represents the Remote Request
- </summary>
- </member>
- <member name="F:Supabase.Postgrest.Requests.CacheBackedRequest`1._instance">
- <summary>
- The Postgrest Table Instance
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Requests.CacheBackedRequest`1.CacheKey">
- <summary>
- The Cache lookup key - a Base64 encoded reproducible URL for this request configuration.
- </summary>
- </member>
- <member name="F:Supabase.Postgrest.Requests.CacheBackedRequest`1._cacheProvider">
- <summary>
- The Caching provider.
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Requests.CacheBackedRequest`1.Models">
- <summary>
- The Models returned either by Cache Hit or Remote Response
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Requests.CacheBackedRequest`1.Response">
- <summary>
- The response (if applicable) from <see cref="F:Supabase.Postgrest.Requests.CacheBackedRequest`1._remoteRequestAction"/>
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Requests.CacheBackedRequest`1.WasCacheHit">
- <summary>
- If the cache was hit for this request.
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Requests.CacheBackedRequest`1.WasResponseCached">
- <summary>
- If the response was stored in cache.
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Requests.CacheBackedRequest`1.CacheTime">
- <summary>
- The stored cache time in UTC.
- </summary>
- </member>
- <member name="E:Supabase.Postgrest.Requests.CacheBackedRequest`1.PropertyChanged">
- <inheritdoc />
- </member>
- <member name="E:Supabase.Postgrest.Requests.CacheBackedRequest`1.RemoteModelsPopulated">
- <summary>
- Invoked when Remote Models have been populated on this object.
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Requests.CacheBackedRequest`1.#ctor(Supabase.Postgrest.Interfaces.IPostgrestTableWithCache{`0},Supabase.Postgrest.Interfaces.IPostgrestCacheProvider,System.Func{System.Threading.Tasks.Task{Supabase.Postgrest.Responses.ModeledResponse{`0}}})">
- <summary>
- Constructs a Cache Backed Request that automatically populates itself using the Cache provider (if possible).
- </summary>
- <param name="instance"></param>
- <param name="cacheProvider"></param>
- <param name="remoteRequestAction"></param>
- </member>
- <member name="M:Supabase.Postgrest.Requests.CacheBackedRequest`1.TryLoadFromCache">
- <summary>
- Attempts to load a model from the cache.
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Requests.CacheBackedRequest`1.Invoke">
- <summary>
- Invokes the stored <see cref="F:Supabase.Postgrest.Requests.CacheBackedRequest`1._remoteRequestAction"/>
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Requests.CacheBackedRequest`1.Cache(Supabase.Postgrest.Responses.ModeledResponse{`0})">
- <summary>
- Caches a modeled response using the <see cref="F:Supabase.Postgrest.Requests.CacheBackedRequest`1._cacheProvider"/>
- </summary>
- <param name="response"></param>
- </member>
- <member name="M:Supabase.Postgrest.Requests.CacheBackedRequest`1.OnPropertyChanged(System.String)">
- <summary>
- Raises a property change event.
- </summary>
- <param name="propertyName"></param>
- </member>
- <member name="M:Supabase.Postgrest.Requests.CacheBackedRequest`1.SetField``1(``0@,``0,System.String)">
- <summary>
- Sets a field within this instance and raises <see cref="M:Supabase.Postgrest.Requests.CacheBackedRequest`1.OnPropertyChanged(System.String)"/>
- </summary>
- <param name="field"></param>
- <param name="value"></param>
- <param name="propertyName"></param>
- <typeparam name="T"></typeparam>
- <returns></returns>
- </member>
- <member name="T:Supabase.Postgrest.Responses.BaseResponse">
- <summary>
- A wrapper class from which all Responses derive.
- </summary>
- </member>
- <member name="T:Supabase.Postgrest.Responses.ModeledResponse`1">
- <summary>
- A representation of a successful Postgrest response that transforms the string response into a C# Modelled response.
- </summary>
- <typeparam name="T"></typeparam>
- </member>
- <member name="P:Supabase.Postgrest.Responses.ModeledResponse`1.Model">
- <summary>
- The first model in the response.
- </summary>
- </member>
- <member name="P:Supabase.Postgrest.Responses.ModeledResponse`1.Models">
- <summary>
- A list of models in the response.
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.Responses.ModeledResponse`1.#ctor(Supabase.Postgrest.Responses.BaseResponse,Newtonsoft.Json.JsonSerializerSettings,System.Func{System.Collections.Generic.Dictionary{System.String,System.String}},System.Boolean)">
- <inheritdoc />
- </member>
- <member name="T:Supabase.Postgrest.Table`1">
- <summary>
- Class created from a model derived from `BaseModel` that can generate query requests to a Postgrest Endpoint.
-
- Representative of a `USE $TABLE` command.
- </summary>
- <typeparam name="TModel">Model derived from `BaseModel`.</typeparam>
- </member>
- <member name="P:Supabase.Postgrest.Table`1.BaseUrl">
- <inheritdoc />
- </member>
- <member name="P:Supabase.Postgrest.Table`1.TableName">
- <inheritdoc />
- </member>
- <member name="P:Supabase.Postgrest.Table`1.GetHeaders">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.#ctor(System.String,Newtonsoft.Json.JsonSerializerSettings,Supabase.Postgrest.ClientOptions)">
- <summary>
- Typically called from the Client `new Client.Table<ModelType>`
- </summary>
- <param name="baseUrl">Api Endpoint (ex: "http://localhost:8000"), no trailing slash required.</param>
- <param name="serializerSettings"></param>
- <param name="options">Optional client configuration.</param>
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Filter``1(System.Linq.Expressions.Expression{System.Func{`0,System.Object}},Supabase.Postgrest.Constants.Operator,``0)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Filter``1(System.String,Supabase.Postgrest.Constants.Operator,``0)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Not(Supabase.Postgrest.Interfaces.IPostgrestQueryFilter)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Not``1(System.String,Supabase.Postgrest.Constants.Operator,``0)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Not``1(System.Linq.Expressions.Expression{System.Func{`0,System.Object}},Supabase.Postgrest.Constants.Operator,``0)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Not``1(System.String,Supabase.Postgrest.Constants.Operator,System.Collections.Generic.List{``0})">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Not``1(System.Linq.Expressions.Expression{System.Func{`0,System.Object}},Supabase.Postgrest.Constants.Operator,System.Collections.Generic.List{``0})">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Not(System.String,Supabase.Postgrest.Constants.Operator,System.Collections.Generic.Dictionary{System.String,System.Object})">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Not(System.Linq.Expressions.Expression{System.Func{`0,System.Object}},Supabase.Postgrest.Constants.Operator,System.Collections.Generic.Dictionary{System.String,System.Object})">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.And(System.Collections.Generic.List{Supabase.Postgrest.Interfaces.IPostgrestQueryFilter})">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Or(System.Collections.Generic.List{Supabase.Postgrest.Interfaces.IPostgrestQueryFilter})">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Match(`0)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Match(System.Collections.Generic.Dictionary{System.String,System.String})">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Order(System.Linq.Expressions.Expression{System.Func{`0,System.Object}},Supabase.Postgrest.Constants.Ordering,Supabase.Postgrest.Constants.NullPosition)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Order(System.String,Supabase.Postgrest.Constants.Ordering,Supabase.Postgrest.Constants.NullPosition)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Order(System.String,System.String,Supabase.Postgrest.Constants.Ordering,Supabase.Postgrest.Constants.NullPosition)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Range(System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Range(System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Select(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Select(System.Linq.Expressions.Expression{System.Func{`0,System.Object[]}})">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Where(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}})">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Limit(System.Int32,System.String)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.OnConflict(System.String)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.OnConflict(System.Linq.Expressions.Expression{System.Func{`0,System.Object}})">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Columns(System.String[])">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Columns(System.Linq.Expressions.Expression{System.Func{`0,System.Object[]}})">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Offset(System.Int32,System.String)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Insert(`0,Supabase.Postgrest.QueryOptions,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Insert(System.Collections.Generic.ICollection{`0},Supabase.Postgrest.QueryOptions,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Upsert(`0,Supabase.Postgrest.QueryOptions,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Upsert(System.Collections.Generic.ICollection{`0},Supabase.Postgrest.QueryOptions,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Set(System.Linq.Expressions.Expression{System.Func{`0,System.Object}},System.Object)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Set(System.Linq.Expressions.Expression{System.Func{`0,System.Collections.Generic.KeyValuePair{System.Object,System.Object}}})">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Update(Supabase.Postgrest.QueryOptions,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Update(`0,Supabase.Postgrest.QueryOptions,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Delete(Supabase.Postgrest.QueryOptions,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Delete(`0,Supabase.Postgrest.QueryOptions,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Count(Supabase.Postgrest.Constants.CountType,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Single(System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Get(System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.GenerateUrl">
- <summary>
- Generates the encoded URL with defined query parameters that will be sent to the Postgrest API.
- </summary>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Table`1.PrepareRequestData(System.Object,System.Boolean,System.Boolean,System.Boolean)">
- <summary>
- Transforms an object into a string mapped list/dictionary using `JsonSerializerSettings`.
- </summary>
- <param name="data"></param>
- <param name="isInsert"></param>
- <param name="isUpdate"></param>
- <param name="isUpsert"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Table`1.PrepareFilter(Supabase.Postgrest.Interfaces.IPostgrestQueryFilter)">
- <summary>
- Transforms the defined filters into the expected Postgrest format.
-
- See: http://postgrest.org/en/v7.0.0/api.html#operators
- </summary>
- <param name="filter"></param>
- <returns></returns>
- </member>
- <member name="M:Supabase.Postgrest.Table`1.Clear">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.Table`1.PerformInsert(System.Object,Supabase.Postgrest.QueryOptions,System.Threading.CancellationToken)">
- <summary>
- Performs an INSERT Request.
- </summary>
- <param name="data"></param>
- <param name="options"></param>
- <param name="cancellationToken"></param>
- <returns></returns>
- </member>
- <member name="T:Supabase.Postgrest.TableWithCache`1">
- <summary>
- Represents a table constructed with a <see cref="T:Supabase.Postgrest.Interfaces.IPostgrestCacheProvider"/>
- </summary>
- <typeparam name="T"></typeparam>
- </member>
- <member name="P:Supabase.Postgrest.TableWithCache`1.CacheProvider">
- <summary>
- Represents a caching provider to be used with Get Requests.
- </summary>
- </member>
- <member name="M:Supabase.Postgrest.TableWithCache`1.#ctor(System.String,Supabase.Postgrest.Interfaces.IPostgrestCacheProvider,Newtonsoft.Json.JsonSerializerSettings,Supabase.Postgrest.ClientOptions)">
- <inheritdoc />
- </member>
- <member name="M:Supabase.Postgrest.TableWithCache`1.Get(System.Threading.CancellationToken)">
- <summary>
-
- </summary>
- <param name="cancellationToken"></param>
- <returns></returns>
- </member>
- <member name="M:System.Runtime.CompilerServices.RuntimeHelpers.GetSubArray``1(``0[],Supabase.Postgrest.IntRange)">
- <summary>
- Slices the specified array using the specified range.
- </summary>
- </member>
- </members>
- </doc>
|