join 句 (C# リファレンス)

[アーティクル]
04/07/2023

join 句は、オブジェクトモデル内での直接リレーションシップがない、さまざまなソースシーケンスの要素を関連付ける際に役立ちます。唯一の要件は、等価性を比較できるいくつかの値が各ソース内の要素間で共有されていることです。たとえば、食品販売会社には特定の商品についての供給元のリストと購入者のリストがあります。 join 句は、たとえば指定された地域のすべての供給元および購入者のリストを作成するために使用できます。

join 句では、2 つのソースシーケンスを入力として受け取ります。各シーケンスの要素は、もう一方のシーケンスの対応するプロパティと比較できるプロパティであるか、そのプロパティを含む要素であることが必要です。 join 句では、特殊な equals キーワードを使用して、指定されたキーの等価性が比較されます。 join 句によって実行される結合はすべてが等結合です。 join 句の出力形式は、実行する結合の種類によって異なります。最も一般的な 3 種類の結合を以下に示します。

内部結合
グループ結合
左外部結合

内部結合

次の例は、単純な内部等結合を示しています。このクエリによって "商品名/カテゴリ" のペアからなるフラットなシーケンスが生成されます。複数の要素に同じカテゴリ文字列が含まれます。 categories の要素に一致する products がない場合、そのカテゴリは結果に含まれません。

var innerJoinQuery =
    from category in categories
    join prod in products on category.ID equals prod.CategoryID
    select new { ProductName = prod.Name, Category = category.Name }; //produces flat sequence

詳細については、「内部結合の実行」を参照してください。

グループ結合

into 式を使用した join 句はグループ結合と呼ばれます。

var innerGroupJoinQuery =
    from category in categories
    join prod in products on category.ID equals prod.CategoryID into prodGroup
    select new { CategoryName = category.Name, Products = prodGroup };

グループ結合によって生成される階層形式の結果シーケンスでは、左側のソースシーケンスの要素と一致する右側のソースシーケンスの 1 つ以上の要素が関連付けられています。リレーショナルデータベースにおいてグループ結合に相当する用語はありません。グループ結合とは、本質的にはオブジェクト配列のシーケンスです。

右側のソースシーケンスの要素に左側のソースの要素と一致するものが見つからない場合は、その項目に対して join 句によって空の配列が生成されます。つまりグループ結合は、結果シーケンスがグループに整理されることを除けば、基本的には内部等結合です。

グループ結合の結果を選択しただけでは、項目にアクセスすることはできでも、その照合に使用するキーを特定することはできません。そのため、通常はグループ結合の結果を選択し、前の例に示したようなキー名を含む新しい型にするとさらに便利になります。

また、当然ながらグループ結合の結果を別のサブクエリのジェネレーターとして使用することもできます。

var innerGroupJoinQuery2 =
    from category in categories
    join prod in products on category.ID equals prod.CategoryID into prodGroup
    from prod2 in prodGroup
    where prod2.UnitPrice > 2.50M
    select prod2;

詳細については、「グループ結合の実行」を参照してください。

左外部結合

左外部結合では、右側のシーケンスに一致する要素がなくても、左側のソースシーケンスのすべての要素が返されます。 LINQ で左外部結合を実行するには、DefaultIfEmpty メソッドとグループ結合を組み合わせて使用し、左側の要素に一致するものがない場合に既定の右側の要素を生成するように指定します。参照型用の既定値として null を使用するか、ユーザー定義の既定の型を指定できます。次の例では、ユーザー定義の既定の型を示しています。

var leftOuterJoinQuery =
    from category in categories
    join prod in products on category.ID equals prod.CategoryID into prodGroup
    from item in prodGroup.DefaultIfEmpty(new Product { Name = String.Empty, CategoryID = 0 })
    select new { CatName = category.Name, ProdName = item.Name };

詳細については、「左外部結合の実行」を参照してください。

等値演算子

join 句は等結合を実行します。つまり、基準にできるのは 2 つのキーの等価性に関する照合のみです。 "～より大きい" や "等しくない" など、他の種類の比較はサポートされていません。すべての結合が等結合であることを明確化するために、join 句では == 演算子ではなく equals キーワードを使用します。 equals キーワードは join 句でしか使用できず、また == 演算子とはいくつかの重要な点で異なります。文字列を比較する場合、equals には値によって比較するオーバーロードがあり、演算子 == は参照の等価性を使用します。比較の両側が同じ文字列変数を持つ場合、equals と == は同じ結果 (true) になります。これは、プログラムで 2 つ以上の同等の文字列変数を宣言すると、コンパイラがそれらすべてを同じ場所に格納するためです。これは "インターン" と呼ばれます。もう 1 つの重要な違いは null 比較です。null equals null は、equals 演算子を使用して false と評価されますが、== 演算子では true と評価されます。最後に、スコープ動作が異なります。equals を指定すると、左側のキーでは外部のソースシーケンス、右側のキーでは内部のソースが使用されます。外部のソースは equals の左側のスコープ内、内部のソースシーケンスは右側のスコープ内でのみ使用できます。

非等結合

複数の from 句を使用して新しいシーケンスをクエリに個別に導入することで、非等結合、クロス結合、およびその他のカスタム結合操作を実行できます。詳細については、「カスタム結合操作の実行」を参照してください。

オブジェクトコレクションとリレーショナルテーブルでの結合の比較

LINQ クエリ式での結合操作は、オブジェクトコレクションに対して実行されます。 2 つのリレーショナルテーブルの "結合" とまったく同じ方法でオブジェクトコレクションを結合することはできません。 LINQ では、2 つのソースシーケンスがリレーションシップによって関連付けられていない場合にのみ明示的な join 句が必要になります。 LINQ to SQL を使用する場合、外部キーテーブルはオブジェクトモデル内でプライマリテーブルのプロパティとして表されます。たとえば Northwind データベースでは、Customer テーブルに Orders テーブルとの外部キーリレーションシップがあります。テーブルをオブジェクトモデルに割り当てると、Customer クラスには、その Customer に関連付けられた Orders のコレクションを含む Orders プロパティが含まれます。実質的には、既に結合が実行されていることになります。

LINQ to SQL を使用した関連テーブル間でのクエリの詳細については、「方法: データベースリレーションシップを割り当てる」を参照してください。

複合キー

複合キーを使用すると、複数の値の等価性をテストできます。詳細については、「複合キーを使用した結合」を参照してください。複合キーは、group 句でも使用できます。

例

次の例では、同じ照合キーを使用し、同じデータソースでの内部結合、グループ結合、左外部結合の結果を比較しています。これらの例には、結果をコンソールにわかりやすく表示するためのコードがいくつか追加されています。

class JoinDemonstration
{
    #region Data

    class Product
    {
        public required string Name { get; init; }
        public required int CategoryID { get; init; }
    }

    class Category
    {
        public required string Name { get; init; }
        public required int ID { get; init; }
    }

    // Specify the first data source.
    List<Category> categories =
    [
        new Category {Name="Beverages", ID=001},
        new Category {Name="Condiments", ID=002},
        new Category {Name="Vegetables", ID=003},
        new Category {Name="Grains", ID=004},
        new Category {Name="Fruit", ID=005}
    ];

    // Specify the second data source.
    List<Product> products =
    [
      new Product {Name="Cola",  CategoryID=001},
      new Product {Name="Tea",  CategoryID=001},
      new Product {Name="Mustard", CategoryID=002},
      new Product {Name="Pickles", CategoryID=002},
      new Product {Name="Carrots", CategoryID=003},
      new Product {Name="Bok Choy", CategoryID=003},
      new Product {Name="Peaches", CategoryID=005},
      new Product {Name="Melons", CategoryID=005},
    ];
    #endregion

    static void Main(string[] args)
    {
        JoinDemonstration app = new JoinDemonstration();

        app.InnerJoin();
        app.GroupJoin();
        app.GroupInnerJoin();
        app.GroupJoin3();
        app.LeftOuterJoin();
        app.LeftOuterJoin2();
    }

    void InnerJoin()
    {
        // Create the query that selects
        // a property from each element.
        var innerJoinQuery =
           from category in categories
           join prod in products on category.ID equals prod.CategoryID
           select new { Category = category.ID, Product = prod.Name };

        Console.WriteLine("InnerJoin:");
        // Execute the query. Access results
        // with a simple foreach statement.
        foreach (var item in innerJoinQuery)
        {
            Console.WriteLine("{0,-10}{1}", item.Product, item.Category);
        }
        Console.WriteLine("InnerJoin: {0} items in 1 group.", innerJoinQuery.Count());
        Console.WriteLine(System.Environment.NewLine);
    }

    void GroupJoin()
    {
        // This is a demonstration query to show the output
        // of a "raw" group join. A more typical group join
        // is shown in the GroupInnerJoin method.
        var groupJoinQuery =
           from category in categories
           join prod in products on category.ID equals prod.CategoryID into prodGroup
           select prodGroup;

        // Store the count of total items (for demonstration only).
        int totalItems = 0;

        Console.WriteLine("Simple GroupJoin:");

        // A nested foreach statement is required to access group items.
        foreach (var prodGrouping in groupJoinQuery)
        {
            Console.WriteLine("Group:");
            foreach (var item in prodGrouping)
            {
                totalItems++;
                Console.WriteLine("   {0,-10}{1}", item.Name, item.CategoryID);
            }
        }
        Console.WriteLine("Unshaped GroupJoin: {0} items in {1} unnamed groups", totalItems, groupJoinQuery.Count());
        Console.WriteLine(System.Environment.NewLine);
    }

    void GroupInnerJoin()
    {
        var groupJoinQuery2 =
            from category in categories
            orderby category.ID
            join prod in products on category.ID equals prod.CategoryID into prodGroup
            select new
            {
                Category = category.Name,
                Products = from prod2 in prodGroup
                           orderby prod2.Name
                           select prod2
            };

        //Console.WriteLine("GroupInnerJoin:");
        int totalItems = 0;

        Console.WriteLine("GroupInnerJoin:");
        foreach (var productGroup in groupJoinQuery2)
        {
            Console.WriteLine(productGroup.Category);
            foreach (var prodItem in productGroup.Products)
            {
                totalItems++;
                Console.WriteLine("  {0,-10} {1}", prodItem.Name, prodItem.CategoryID);
            }
        }
        Console.WriteLine("GroupInnerJoin: {0} items in {1} named groups", totalItems, groupJoinQuery2.Count());
        Console.WriteLine(System.Environment.NewLine);
    }

    void GroupJoin3()
    {

        var groupJoinQuery3 =
            from category in categories
            join product in products on category.ID equals product.CategoryID into prodGroup
            from prod in prodGroup
            orderby prod.CategoryID
            select new { Category = prod.CategoryID, ProductName = prod.Name };

        //Console.WriteLine("GroupInnerJoin:");
        int totalItems = 0;

        Console.WriteLine("GroupJoin3:");
        foreach (var item in groupJoinQuery3)
        {
            totalItems++;
            Console.WriteLine("   {0}:{1}", item.ProductName, item.Category);
        }

        Console.WriteLine("GroupJoin3: {0} items in 1 group", totalItems);
        Console.WriteLine(System.Environment.NewLine);
    }

    void LeftOuterJoin()
    {
        // Create the query.
        var leftOuterQuery =
           from category in categories
           join prod in products on category.ID equals prod.CategoryID into prodGroup
           select prodGroup.DefaultIfEmpty(new Product() { Name = "Nothing!", CategoryID = category.ID });

        // Store the count of total items (for demonstration only).
        int totalItems = 0;

        Console.WriteLine("Left Outer Join:");

        // A nested foreach statement  is required to access group items
        foreach (var prodGrouping in leftOuterQuery)
        {
            Console.WriteLine("Group:");
            foreach (var item in prodGrouping)
            {
                totalItems++;
                Console.WriteLine("  {0,-10}{1}", item.Name, item.CategoryID);
            }
        }
        Console.WriteLine("LeftOuterJoin: {0} items in {1} groups", totalItems, leftOuterQuery.Count());
        Console.WriteLine(System.Environment.NewLine);
    }

    void LeftOuterJoin2()
    {
        // Create the query.
        var leftOuterQuery2 =
           from category in categories
           join prod in products on category.ID equals prod.CategoryID into prodGroup
           from item in prodGroup.DefaultIfEmpty()
           select new { Name = item == null ? "Nothing!" : item.Name, CategoryID = category.ID };

        Console.WriteLine("LeftOuterJoin2: {0} items in 1 group", leftOuterQuery2.Count());
        // Store the count of total items
        int totalItems = 0;

        Console.WriteLine("Left Outer Join 2:");

        // Groups have been flattened.
        foreach (var item in leftOuterQuery2)
        {
            totalItems++;
            Console.WriteLine("{0,-10}{1}", item.Name, item.CategoryID);
        }
        Console.WriteLine("LeftOuterJoin2: {0} items in 1 group", totalItems);
    }
}
/*Output:

InnerJoin:
Cola      1
Tea       1
Mustard   2
Pickles   2
Carrots   3
Bok Choy  3
Peaches   5
Melons    5
InnerJoin: 8 items in 1 group.


Unshaped GroupJoin:
Group:
    Cola      1
    Tea       1
Group:
    Mustard   2
    Pickles   2
Group:
    Carrots   3
    Bok Choy  3
Group:
Group:
    Peaches   5
    Melons    5
Unshaped GroupJoin: 8 items in 5 unnamed groups


GroupInnerJoin:
Beverages
    Cola       1
    Tea        1
Condiments
    Mustard    2
    Pickles    2
Vegetables
    Bok Choy   3
    Carrots    3
Grains
Fruit
    Melons     5
    Peaches    5
GroupInnerJoin: 8 items in 5 named groups


GroupJoin3:
    Cola:1
    Tea:1
    Mustard:2
    Pickles:2
    Carrots:3
    Bok Choy:3
    Peaches:5
    Melons:5
GroupJoin3: 8 items in 1 group


Left Outer Join:
Group:
    Cola      1
    Tea       1
Group:
    Mustard   2
    Pickles   2
Group:
    Carrots   3
    Bok Choy  3
Group:
    Nothing!  4
Group:
    Peaches   5
    Melons    5
LeftOuterJoin: 9 items in 5 groups


LeftOuterJoin2: 9 items in 1 group
Left Outer Join 2:
Cola      1
Tea       1
Mustard   2
Pickles   2
Carrots   3
Bok Choy  3
Nothing!  4
Peaches   5
Melons    5
LeftOuterJoin2: 9 items in 1 group
Press any key to exit.
*/

Remarks

join 句の後に into がない場合は、Join メソッド呼び出しに変換されます。 join 句の後に into がある場合は、GroupJoin メソッド呼び出しに変換されます。

join 句 (C# リファレンス)

内部結合

グループ結合

左外部結合

等値演算子

非等結合

オブジェクトコレクションとリレーショナルテーブルでの結合の比較

複合キー

例

Remarks

関連項目

フィードバック

その他のリソース

join 句 (C# リファレンス)

内部結合

グループ結合

左外部結合

等値演算子

非等結合

オブジェクト コレクションとリレーショナル テーブルでの結合の比較

複合キー

例

Remarks

関連項目

フィードバック

その他のリソース

オブジェクトコレクションとリレーショナルテーブルでの結合の比較