| | | 1 | | using System.Buffers; |
| | | 2 | | using System.Text; |
| | | 3 | | using NGql.Core.Abstractions; |
| | | 4 | | |
| | | 5 | | namespace NGql.Core; |
| | | 6 | | |
| | | 7 | | /// <summary> |
| | | 8 | | /// Builds a GraphQL <c>mutation</c> operation. Use <see cref="Select(NGql.Core.Query)"/> to |
| | | 9 | | /// embed a sub-<see cref="Query"/> that carries arguments via <see cref="Query.Where(string, object)"/>, |
| | | 10 | | /// or <see cref="Select(string[])"/> for plain field names. |
| | | 11 | | /// </summary> |
| | | 12 | | /// <remarks> |
| | | 13 | | /// <para> |
| | | 14 | | /// <b>New code should prefer <see cref="Builders.QueryBuilder.CreateMutationBuilder(string)"/>.</b> |
| | | 15 | | /// The fluent <see cref="Builders.QueryBuilder"/> surface is the recommended way to author both |
| | | 16 | | /// queries and mutations in NGql 2.x and beyond — it offers a richer API (<c>Include</c>, |
| | | 17 | | /// <c>WithMetadata</c>, sub-field lambdas, <c>PreservationBuilder</c> support) and avoids the |
| | | 18 | | /// classic <see cref="Query"/>+<c>Where</c> idiom required by <see cref="Mutation"/> for |
| | | 19 | | /// argument-bearing root fields. |
| | | 20 | | /// </para> |
| | | 21 | | /// <para> |
| | | 22 | | /// <see cref="Mutation"/> remains supported for backwards compatibility with NGql 1.x call sites |
| | | 23 | | /// and continues to render the same GraphQL output. There is currently no removal timeline. |
| | | 24 | | /// </para> |
| | | 25 | | /// </remarks> |
| | | 26 | | /// <param name="name">Operation name (rendered as <c>mutation Name(...)</c>).</param> |
| | | 27 | | /// <param name="variables">Operation variables; their <c>$name:Type</c> declarations appear in the operation signature. |
| | 51 | 28 | | public sealed class Mutation(string name, params Variable[] variables) |
| | | 29 | | { |
| | 51 | 30 | | private readonly QueryBlock _block = new(name, "mutation", variables: variables); |
| | | 31 | | |
| | | 32 | | /// <inheritdoc cref="QueryBlock.Name"/> |
| | 3 | 33 | | public string Name => _block.Name; |
| | | 34 | | |
| | | 35 | | /// <inheritdoc cref="QueryBlock.FieldsList"/> |
| | 6 | 36 | | public IEnumerable<object> FieldsList => _block.FieldsList; |
| | | 37 | | |
| | | 38 | | /// <inheritdoc cref="QueryBlock.Variables"/> |
| | 6 | 39 | | public IEnumerable<Variable> Variables => _block.Variables; |
| | | 40 | | |
| | | 41 | | /// <inheritdoc cref="QueryBlock.AddVariable(NGql.Core.Variable)"/> |
| | | 42 | | public Mutation Variable(Variable variable) |
| | | 43 | | { |
| | 9 | 44 | | _block.AddVariable(variable); |
| | 9 | 45 | | return this; |
| | | 46 | | } |
| | | 47 | | |
| | | 48 | | /// <inheritdoc cref="QueryBlock.AddVariable(string,string)"/> |
| | | 49 | | public Mutation Variable(string name, string type) |
| | | 50 | | { |
| | 3 | 51 | | _block.AddVariable(name, type); |
| | 3 | 52 | | return this; |
| | | 53 | | } |
| | | 54 | | |
| | | 55 | | /// <inheritdoc cref="QueryBlock.AddField(System.Collections.Generic.IEnumerable{object})"/> |
| | | 56 | | public Mutation Select(IEnumerable<object> selectList) |
| | | 57 | | { |
| | 3 | 58 | | _block.AddField(selectList); |
| | 3 | 59 | | return this; |
| | | 60 | | } |
| | | 61 | | |
| | | 62 | | /// <inheritdoc cref="QueryBlock.AddField(string[])"/> |
| | | 63 | | public Mutation Select(params string[] selects) |
| | | 64 | | { |
| | 15 | 65 | | _block.AddField(selects); |
| | 15 | 66 | | return this; |
| | | 67 | | } |
| | | 68 | | |
| | | 69 | | /// <inheritdoc cref="QueryBlock.AddField(QueryBlock)"/> |
| | | 70 | | public Mutation Select(Query subQuery) |
| | | 71 | | { |
| | 33 | 72 | | _block.AddField(subQuery.Block); |
| | 33 | 73 | | return this; |
| | | 74 | | } |
| | | 75 | | |
| | 18 | 76 | | public override string ToString() => _block.ToString(); |
| | | 77 | | |
| | | 78 | | /// <inheritdoc cref="QueryBlock.AppendTo(System.Text.StringBuilder)"/> |
| | 6 | 79 | | public void AppendTo(StringBuilder builder) => _block.AppendTo(builder); |
| | | 80 | | |
| | | 81 | | /// <inheritdoc cref="QueryBlock.WriteTo(System.IO.TextWriter)"/> |
| | 6 | 82 | | public void WriteTo(TextWriter writer) => _block.WriteTo(writer); |
| | | 83 | | |
| | | 84 | | /// <inheritdoc cref="QueryBlock.WriteUtf8(System.Buffers.IBufferWriter{System.Byte})"/> |
| | 6 | 85 | | public void WriteUtf8(IBufferWriter<byte> bufferWriter) => _block.WriteUtf8(bufferWriter); |
| | | 86 | | |
| | 15 | 87 | | public static implicit operator string(Mutation mutation) => mutation._block.ToString(); |
| | | 88 | | } |